/**
* GitLab API
* An OpenAPI definition for the GitLab REST API. Few API resources or endpoints are currently included. The intent is to expand this to match the entire Markdown documentation of the API: . Contributions are welcome. When viewing this on gitlab.com, you can test API calls directly from the browser against the `gitlab.com` instance, if you are logged in. The feature uses the current [GitLab session cookie](https://docs.gitlab.com/ee/api/#session-cookie), so each request is made using your account. Instructions for using this tool can be found in [Interactive API Documentation](https://docs.gitlab.com/ee/api/openapi/openapi_interactive.html)
*
* The version of the OpenAPI document: v4
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import type { Configuration } from './configuration.js';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import globalAxios from 'axios';
import type { RequestArgs } from './base.js';
import { BaseAPI } from './base.js';
/**
* API_Entities_AccessRequester model
* @export
* @interface APIEntitiesAccessRequester
*/
export interface APIEntitiesAccessRequester {
/**
*
* @type {number}
* @memberof APIEntitiesAccessRequester
*/
'id'?: number;
/**
*
* @type {string}
* @memberof APIEntitiesAccessRequester
*/
'username'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesAccessRequester
*/
'name'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesAccessRequester
*/
'state'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesAccessRequester
*/
'avatar_url'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesAccessRequester
*/
'avatar_path'?: string;
/**
*
* @type {Array}
* @memberof APIEntitiesAccessRequester
*/
'custom_attributes'?: Array;
/**
*
* @type {string}
* @memberof APIEntitiesAccessRequester
*/
'web_url'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesAccessRequester
*/
'email'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesAccessRequester
*/
'requested_at'?: string;
}
/**
* API_Entities_Appearance model
* @export
* @interface APIEntitiesAppearance
*/
export interface APIEntitiesAppearance {
/**
*
* @type {string}
* @memberof APIEntitiesAppearance
*/
'title'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesAppearance
*/
'description'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesAppearance
*/
'pwa_name'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesAppearance
*/
'pwa_short_name'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesAppearance
*/
'pwa_description'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesAppearance
*/
'logo'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesAppearance
*/
'pwa_icon'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesAppearance
*/
'header_logo'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesAppearance
*/
'favicon'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesAppearance
*/
'new_project_guidelines'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesAppearance
*/
'profile_image_guidelines'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesAppearance
*/
'header_message'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesAppearance
*/
'footer_message'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesAppearance
*/
'message_background_color'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesAppearance
*/
'message_font_color'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesAppearance
*/
'email_header_and_footer_enabled'?: string;
}
/**
* API_Entities_Application model
* @export
* @interface APIEntitiesApplication
*/
export interface APIEntitiesApplication {
/**
*
* @type {string}
* @memberof APIEntitiesApplication
*/
'id'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesApplication
*/
'application_id'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesApplication
*/
'application_name'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesApplication
*/
'callback_url'?: string;
/**
*
* @type {boolean}
* @memberof APIEntitiesApplication
*/
'confidential'?: boolean;
}
/**
* API_Entities_ApplicationWithSecret model
* @export
* @interface APIEntitiesApplicationWithSecret
*/
export interface APIEntitiesApplicationWithSecret {
/**
*
* @type {string}
* @memberof APIEntitiesApplicationWithSecret
*/
'id'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesApplicationWithSecret
*/
'application_id'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesApplicationWithSecret
*/
'application_name'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesApplicationWithSecret
*/
'callback_url'?: string;
/**
*
* @type {boolean}
* @memberof APIEntitiesApplicationWithSecret
*/
'confidential'?: boolean;
/**
*
* @type {string}
* @memberof APIEntitiesApplicationWithSecret
*/
'secret'?: string;
}
/**
* API_Entities_Avatar model
* @export
* @interface APIEntitiesAvatar
*/
export interface APIEntitiesAvatar {
/**
*
* @type {string}
* @memberof APIEntitiesAvatar
*/
'avatar_url'?: string;
}
/**
* API_Entities_Badge model
* @export
* @interface APIEntitiesBadge
*/
export interface APIEntitiesBadge {
/**
*
* @type {string}
* @memberof APIEntitiesBadge
*/
'name'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesBadge
*/
'link_url'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesBadge
*/
'image_url'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesBadge
*/
'rendered_link_url'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesBadge
*/
'rendered_image_url'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesBadge
*/
'id'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesBadge
*/
'kind'?: string;
}
/**
* API_Entities_BasicBadgeDetails model
* @export
* @interface APIEntitiesBasicBadgeDetails
*/
export interface APIEntitiesBasicBadgeDetails {
/**
*
* @type {string}
* @memberof APIEntitiesBasicBadgeDetails
*/
'name'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesBasicBadgeDetails
*/
'link_url'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesBasicBadgeDetails
*/
'image_url'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesBasicBadgeDetails
*/
'rendered_link_url'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesBasicBadgeDetails
*/
'rendered_image_url'?: string;
}
/**
* API_Entities_BatchedBackgroundMigration model
* @export
* @interface APIEntitiesBatchedBackgroundMigration
*/
export interface APIEntitiesBatchedBackgroundMigration {
/**
*
* @type {string}
* @memberof APIEntitiesBatchedBackgroundMigration
*/
'id'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesBatchedBackgroundMigration
*/
'job_class_name'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesBatchedBackgroundMigration
*/
'table_name'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesBatchedBackgroundMigration
*/
'status'?: string;
/**
*
* @type {number}
* @memberof APIEntitiesBatchedBackgroundMigration
*/
'progress'?: number;
/**
*
* @type {string}
* @memberof APIEntitiesBatchedBackgroundMigration
*/
'created_at'?: string;
}
/**
* API_Entities_Branch model
* @export
* @interface APIEntitiesBranch
*/
export interface APIEntitiesBranch {
/**
*
* @type {string}
* @memberof APIEntitiesBranch
*/
'name'?: string;
/**
*
* @type {APIEntitiesCommit}
* @memberof APIEntitiesBranch
*/
'commit'?: APIEntitiesCommit;
/**
*
* @type {boolean}
* @memberof APIEntitiesBranch
*/
'merged'?: boolean;
/**
*
* @type {boolean}
* @memberof APIEntitiesBranch
*/
'protected'?: boolean;
/**
*
* @type {boolean}
* @memberof APIEntitiesBranch
*/
'developers_can_push'?: boolean;
/**
*
* @type {boolean}
* @memberof APIEntitiesBranch
*/
'developers_can_merge'?: boolean;
/**
*
* @type {boolean}
* @memberof APIEntitiesBranch
*/
'can_push'?: boolean;
/**
*
* @type {boolean}
* @memberof APIEntitiesBranch
*/
'default'?: boolean;
/**
*
* @type {string}
* @memberof APIEntitiesBranch
*/
'web_url'?: string;
}
/**
* API_Entities_BroadcastMessage model
* @export
* @interface APIEntitiesBroadcastMessage
*/
export interface APIEntitiesBroadcastMessage {
/**
*
* @type {string}
* @memberof APIEntitiesBroadcastMessage
*/
'id'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesBroadcastMessage
*/
'message'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesBroadcastMessage
*/
'starts_at'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesBroadcastMessage
*/
'ends_at'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesBroadcastMessage
*/
'color'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesBroadcastMessage
*/
'font'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesBroadcastMessage
*/
'target_access_levels'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesBroadcastMessage
*/
'target_path'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesBroadcastMessage
*/
'broadcast_type'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesBroadcastMessage
*/
'dismissable'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesBroadcastMessage
*/
'active'?: string;
}
/**
* API_Entities_BulkImport model
* @export
* @interface APIEntitiesBulkImport
*/
export interface APIEntitiesBulkImport {
/**
*
* @type {number}
* @memberof APIEntitiesBulkImport
*/
'id'?: number;
/**
*
* @type {string}
* @memberof APIEntitiesBulkImport
*/
'status'?: APIEntitiesBulkImportStatusEnum;
/**
*
* @type {string}
* @memberof APIEntitiesBulkImport
*/
'source_type'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesBulkImport
*/
'created_at'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesBulkImport
*/
'updated_at'?: string;
}
export declare const APIEntitiesBulkImportStatusEnum: {
readonly Created: "created";
readonly Started: "started";
readonly Finished: "finished";
readonly Timeout: "timeout";
readonly Failed: "failed";
};
export type APIEntitiesBulkImportStatusEnum = typeof APIEntitiesBulkImportStatusEnum[keyof typeof APIEntitiesBulkImportStatusEnum];
/**
* API_Entities_BulkImports model
* @export
* @interface APIEntitiesBulkImports
*/
export interface APIEntitiesBulkImports {
/**
*
* @type {number}
* @memberof APIEntitiesBulkImports
*/
'id'?: number;
/**
*
* @type {number}
* @memberof APIEntitiesBulkImports
*/
'bulk_import_id'?: number;
/**
*
* @type {string}
* @memberof APIEntitiesBulkImports
*/
'status'?: APIEntitiesBulkImportsStatusEnum;
/**
*
* @type {string}
* @memberof APIEntitiesBulkImports
*/
'entity_type'?: APIEntitiesBulkImportsEntityTypeEnum;
/**
*
* @type {string}
* @memberof APIEntitiesBulkImports
*/
'source_full_path'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesBulkImports
*/
'destination_full_path'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesBulkImports
*/
'destination_name'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesBulkImports
*/
'destination_slug'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesBulkImports
*/
'destination_namespace'?: string;
/**
*
* @type {number}
* @memberof APIEntitiesBulkImports
*/
'parent_id'?: number;
/**
*
* @type {number}
* @memberof APIEntitiesBulkImports
*/
'namespace_id'?: number;
/**
*
* @type {number}
* @memberof APIEntitiesBulkImports
*/
'project_id'?: number;
/**
*
* @type {string}
* @memberof APIEntitiesBulkImports
*/
'created_at'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesBulkImports
*/
'updated_at'?: string;
/**
*
* @type {Array}
* @memberof APIEntitiesBulkImports
*/
'failures'?: Array;
/**
*
* @type {boolean}
* @memberof APIEntitiesBulkImports
*/
'migrate_projects'?: boolean;
}
export declare const APIEntitiesBulkImportsStatusEnum: {
readonly Created: "created";
readonly Started: "started";
readonly Finished: "finished";
readonly Timeout: "timeout";
readonly Failed: "failed";
};
export type APIEntitiesBulkImportsStatusEnum = typeof APIEntitiesBulkImportsStatusEnum[keyof typeof APIEntitiesBulkImportsStatusEnum];
export declare const APIEntitiesBulkImportsEntityTypeEnum: {
readonly Group: "group";
readonly Project: "project";
};
export type APIEntitiesBulkImportsEntityTypeEnum = typeof APIEntitiesBulkImportsEntityTypeEnum[keyof typeof APIEntitiesBulkImportsEntityTypeEnum];
/**
*
* @export
* @interface APIEntitiesBulkImportsEntityFailure
*/
export interface APIEntitiesBulkImportsEntityFailure {
/**
*
* @type {string}
* @memberof APIEntitiesBulkImportsEntityFailure
*/
'relation'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesBulkImportsEntityFailure
*/
'step'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesBulkImportsEntityFailure
*/
'exception_message'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesBulkImportsEntityFailure
*/
'exception_class'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesBulkImportsEntityFailure
*/
'correlation_id_value'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesBulkImportsEntityFailure
*/
'created_at'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesBulkImportsEntityFailure
*/
'pipeline_class'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesBulkImportsEntityFailure
*/
'pipeline_step'?: string;
}
/**
* API_Entities_Ci_Variable model
* @export
* @interface APIEntitiesCiVariable
*/
export interface APIEntitiesCiVariable {
/**
*
* @type {string}
* @memberof APIEntitiesCiVariable
*/
'variable_type'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesCiVariable
*/
'key'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesCiVariable
*/
'value'?: string;
/**
*
* @type {boolean}
* @memberof APIEntitiesCiVariable
*/
'protected'?: boolean;
/**
*
* @type {boolean}
* @memberof APIEntitiesCiVariable
*/
'masked'?: boolean;
/**
*
* @type {boolean}
* @memberof APIEntitiesCiVariable
*/
'raw'?: boolean;
/**
*
* @type {string}
* @memberof APIEntitiesCiVariable
*/
'environment_scope'?: string;
}
/**
* API_Entities_Cluster model
* @export
* @interface APIEntitiesCluster
*/
export interface APIEntitiesCluster {
/**
*
* @type {string}
* @memberof APIEntitiesCluster
*/
'id'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesCluster
*/
'name'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesCluster
*/
'created_at'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesCluster
*/
'domain'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesCluster
*/
'enabled'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesCluster
*/
'managed'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesCluster
*/
'provider_type'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesCluster
*/
'platform_type'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesCluster
*/
'environment_scope'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesCluster
*/
'cluster_type'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesCluster
*/
'namespace_per_environment'?: string;
/**
*
* @type {APIEntitiesUserBasic}
* @memberof APIEntitiesCluster
*/
'user'?: APIEntitiesUserBasic;
/**
*
* @type {APIEntitiesPlatformKubernetes}
* @memberof APIEntitiesCluster
*/
'platform_kubernetes'?: APIEntitiesPlatformKubernetes;
/**
*
* @type {APIEntitiesProviderGcp}
* @memberof APIEntitiesCluster
*/
'provider_gcp'?: APIEntitiesProviderGcp;
/**
*
* @type {APIEntitiesProjectIdentity}
* @memberof APIEntitiesCluster
*/
'management_project'?: APIEntitiesProjectIdentity;
}
/**
*
* @export
* @interface APIEntitiesCommit
*/
export interface APIEntitiesCommit {
/**
*
* @type {string}
* @memberof APIEntitiesCommit
*/
'id'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesCommit
*/
'short_id'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesCommit
*/
'created_at'?: string;
/**
*
* @type {Array}
* @memberof APIEntitiesCommit
*/
'parent_ids'?: Array;
/**
*
* @type {string}
* @memberof APIEntitiesCommit
*/
'title'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesCommit
*/
'message'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesCommit
*/
'author_name'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesCommit
*/
'author_email'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesCommit
*/
'authored_date'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesCommit
*/
'committer_name'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesCommit
*/
'committer_email'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesCommit
*/
'committed_date'?: string;
/**
*
* @type {object}
* @memberof APIEntitiesCommit
*/
'trailers'?: object;
/**
*
* @type {string}
* @memberof APIEntitiesCommit
*/
'web_url'?: string;
}
/**
*
* @export
* @interface APIEntitiesCustomAttribute
*/
export interface APIEntitiesCustomAttribute {
/**
*
* @type {string}
* @memberof APIEntitiesCustomAttribute
*/
'key'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesCustomAttribute
*/
'value'?: string;
}
/**
* API_Entities_Dictionary_Table model
* @export
* @interface APIEntitiesDictionaryTable
*/
export interface APIEntitiesDictionaryTable {
/**
*
* @type {string}
* @memberof APIEntitiesDictionaryTable
*/
'table_name'?: string;
/**
*
* @type {Array}
* @memberof APIEntitiesDictionaryTable
*/
'feature_categories'?: Array;
}
/**
* API_Entities_Job model
* @export
* @interface APIEntitiesJob
*/
export interface APIEntitiesJob {
/**
* The ID of the job
* @type {number}
* @memberof APIEntitiesJob
*/
'id'?: number;
/**
* The name of the job
* @type {string}
* @memberof APIEntitiesJob
*/
'name'?: string;
/**
* The current status of the job
* @type {string}
* @memberof APIEntitiesJob
*/
'status'?: string;
/**
* The stage of the job in the CI/CD pipeline
* @type {string}
* @memberof APIEntitiesJob
*/
'stage'?: string;
/**
* The creation time of the job
* @type {string}
* @memberof APIEntitiesJob
*/
'created_at'?: string;
/**
* The start time of the job
* @type {string}
* @memberof APIEntitiesJob
*/
'started_at'?: string;
/**
* The finish time of the job
* @type {string}
* @memberof APIEntitiesJob
*/
'finished_at'?: string;
/**
*
* @type {APIEntitiesCommit}
* @memberof APIEntitiesJob
*/
'commit'?: APIEntitiesCommit;
/**
* Indicates if the job is archived
* @type {boolean}
* @memberof APIEntitiesJob
*/
'archived'?: boolean;
/**
* Indicates if the job is allowed to fail
* @type {boolean}
* @memberof APIEntitiesJob
*/
'allow_failure'?: boolean;
/**
* The time when the job was erased, if applicable
* @type {string}
* @memberof APIEntitiesJob
*/
'erased_at'?: string;
/**
* The duration of the job in seconds
* @type {number}
* @memberof APIEntitiesJob
*/
'duration'?: number;
/**
* The duration the job was queued before execution, in seconds
* @type {number}
* @memberof APIEntitiesJob
*/
'queued_duration'?: number;
/**
* The reference for the job
* @type {string}
* @memberof APIEntitiesJob
*/
'ref'?: string;
/**
* The artifacts produced by the job
* @type {Array}
* @memberof APIEntitiesJob
*/
'artifacts'?: Array;
/**
* Indicates if the job is tagged
* @type {boolean}
* @memberof APIEntitiesJob
*/
'tag'?: boolean;
/**
* The URL for accessing the job in the web interface
* @type {string}
* @memberof APIEntitiesJob
*/
'web_url'?: string;
/**
*
* @type {APIEntitiesJobProject}
* @memberof APIEntitiesJob
*/
'project'?: APIEntitiesJobProject;
/**
*
* @type {APIEntitiesUserBasic}
* @memberof APIEntitiesJob
*/
'user'?: APIEntitiesUserBasic;
}
/**
*
* @export
* @interface APIEntitiesJobProject
*/
export interface APIEntitiesJobProject {
/**
* Indicates if the CI/CD job token scope setting is enabled for the project
* @type {boolean}
* @memberof APIEntitiesJobProject
*/
'ci_job_token_scope_enabled'?: boolean;
}
/**
* API_Entities_Metadata model
* @export
* @interface APIEntitiesMetadata
*/
export interface APIEntitiesMetadata {
/**
*
* @type {string}
* @memberof APIEntitiesMetadata
*/
'version'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesMetadata
*/
'revision'?: string;
/**
*
* @type {APIEntitiesMetadataKas}
* @memberof APIEntitiesMetadata
*/
'kas'?: APIEntitiesMetadataKas;
/**
*
* @type {boolean}
* @memberof APIEntitiesMetadata
*/
'enterprise'?: boolean;
}
/**
*
* @export
* @interface APIEntitiesMetadataKas
*/
export interface APIEntitiesMetadataKas {
/**
*
* @type {boolean}
* @memberof APIEntitiesMetadataKas
*/
'enabled'?: boolean;
/**
*
* @type {string}
* @memberof APIEntitiesMetadataKas
*/
'externalUrl'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesMetadataKas
*/
'version'?: string;
}
/**
* API_Entities_MetricImage model
* @export
* @interface APIEntitiesMetricImage
*/
export interface APIEntitiesMetricImage {
/**
*
* @type {number}
* @memberof APIEntitiesMetricImage
*/
'id'?: number;
/**
*
* @type {string}
* @memberof APIEntitiesMetricImage
*/
'created_at'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesMetricImage
*/
'filename'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesMetricImage
*/
'file_path'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesMetricImage
*/
'url'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesMetricImage
*/
'url_text'?: string;
}
/**
* API_Entities_PlanLimit model
* @export
* @interface APIEntitiesPlanLimit
*/
export interface APIEntitiesPlanLimit {
/**
*
* @type {number}
* @memberof APIEntitiesPlanLimit
*/
'ci_pipeline_size'?: number;
/**
*
* @type {number}
* @memberof APIEntitiesPlanLimit
*/
'ci_active_jobs'?: number;
/**
*
* @type {number}
* @memberof APIEntitiesPlanLimit
*/
'ci_project_subscriptions'?: number;
/**
*
* @type {number}
* @memberof APIEntitiesPlanLimit
*/
'ci_pipeline_schedules'?: number;
/**
*
* @type {number}
* @memberof APIEntitiesPlanLimit
*/
'ci_needs_size_limit'?: number;
/**
*
* @type {number}
* @memberof APIEntitiesPlanLimit
*/
'ci_registered_group_runners'?: number;
/**
*
* @type {number}
* @memberof APIEntitiesPlanLimit
*/
'ci_registered_project_runners'?: number;
/**
*
* @type {number}
* @memberof APIEntitiesPlanLimit
*/
'conan_max_file_size'?: number;
/**
*
* @type {number}
* @memberof APIEntitiesPlanLimit
*/
'enforcement_limit'?: number;
/**
*
* @type {number}
* @memberof APIEntitiesPlanLimit
*/
'generic_packages_max_file_size'?: number;
/**
*
* @type {number}
* @memberof APIEntitiesPlanLimit
*/
'helm_max_file_size'?: number;
/**
*
* @type {object}
* @memberof APIEntitiesPlanLimit
*/
'limits_history'?: object;
/**
*
* @type {number}
* @memberof APIEntitiesPlanLimit
*/
'maven_max_file_size'?: number;
/**
*
* @type {number}
* @memberof APIEntitiesPlanLimit
*/
'notification_limit'?: number;
/**
*
* @type {number}
* @memberof APIEntitiesPlanLimit
*/
'npm_max_file_size'?: number;
/**
*
* @type {number}
* @memberof APIEntitiesPlanLimit
*/
'nuget_max_file_size'?: number;
/**
*
* @type {number}
* @memberof APIEntitiesPlanLimit
*/
'pipeline_hierarchy_size'?: number;
/**
*
* @type {number}
* @memberof APIEntitiesPlanLimit
*/
'pypi_max_file_size'?: number;
/**
*
* @type {number}
* @memberof APIEntitiesPlanLimit
*/
'terraform_module_max_file_size'?: number;
/**
*
* @type {number}
* @memberof APIEntitiesPlanLimit
*/
'storage_size_limit'?: number;
}
/**
*
* @export
* @interface APIEntitiesPlatformKubernetes
*/
export interface APIEntitiesPlatformKubernetes {
/**
*
* @type {string}
* @memberof APIEntitiesPlatformKubernetes
*/
'api_url'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesPlatformKubernetes
*/
'namespace'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesPlatformKubernetes
*/
'authorization_type'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesPlatformKubernetes
*/
'ca_cert'?: string;
}
/**
*
* @export
* @interface APIEntitiesProjectIdentity
*/
export interface APIEntitiesProjectIdentity {
/**
*
* @type {number}
* @memberof APIEntitiesProjectIdentity
*/
'id'?: number;
/**
*
* @type {string}
* @memberof APIEntitiesProjectIdentity
*/
'description'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesProjectIdentity
*/
'name'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesProjectIdentity
*/
'name_with_namespace'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesProjectIdentity
*/
'path'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesProjectIdentity
*/
'path_with_namespace'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesProjectIdentity
*/
'created_at'?: string;
}
/**
*
* @export
* @interface APIEntitiesProviderGcp
*/
export interface APIEntitiesProviderGcp {
/**
*
* @type {string}
* @memberof APIEntitiesProviderGcp
*/
'cluster_id'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesProviderGcp
*/
'status_name'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesProviderGcp
*/
'gcp_project_id'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesProviderGcp
*/
'zone'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesProviderGcp
*/
'machine_type'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesProviderGcp
*/
'num_nodes'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesProviderGcp
*/
'endpoint'?: string;
}
/**
*
* @export
* @interface APIEntitiesUserBasic
*/
export interface APIEntitiesUserBasic {
/**
*
* @type {number}
* @memberof APIEntitiesUserBasic
*/
'id'?: number;
/**
*
* @type {string}
* @memberof APIEntitiesUserBasic
*/
'username'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesUserBasic
*/
'name'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesUserBasic
*/
'state'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesUserBasic
*/
'avatar_url'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesUserBasic
*/
'avatar_path'?: string;
/**
*
* @type {Array}
* @memberof APIEntitiesUserBasic
*/
'custom_attributes'?: Array;
/**
*
* @type {string}
* @memberof APIEntitiesUserBasic
*/
'web_url'?: string;
/**
*
* @type {string}
* @memberof APIEntitiesUserBasic
*/
'email'?: string;
}
/**
*
* @export
* @interface DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter
*/
export interface DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter {
}
/**
*
* @export
* @interface PostApiV4AdminCiVariablesRequest
*/
export interface PostApiV4AdminCiVariablesRequest {
/**
* The key of the variable. Max 255 characters
* @type {string}
* @memberof PostApiV4AdminCiVariablesRequest
*/
'key': string;
/**
* The value of a variable
* @type {string}
* @memberof PostApiV4AdminCiVariablesRequest
*/
'value': string;
/**
* Whether the variable is protected
* @type {boolean}
* @memberof PostApiV4AdminCiVariablesRequest
*/
'protected'?: boolean;
/**
* Whether the variable is masked
* @type {boolean}
* @memberof PostApiV4AdminCiVariablesRequest
*/
'masked'?: boolean;
/**
* Whether the variable will be expanded
* @type {boolean}
* @memberof PostApiV4AdminCiVariablesRequest
*/
'raw'?: boolean;
/**
* The type of a variable. Available types are: env_var (default) and file
* @type {string}
* @memberof PostApiV4AdminCiVariablesRequest
*/
'variable_type'?: PostApiV4AdminCiVariablesRequestVariableTypeEnum;
}
export declare const PostApiV4AdminCiVariablesRequestVariableTypeEnum: {
readonly EnvVar: "env_var";
readonly File: "file";
};
export type PostApiV4AdminCiVariablesRequestVariableTypeEnum = typeof PostApiV4AdminCiVariablesRequestVariableTypeEnum[keyof typeof PostApiV4AdminCiVariablesRequestVariableTypeEnum];
/**
*
* @export
* @interface PostApiV4AdminClustersAddRequest
*/
export interface PostApiV4AdminClustersAddRequest {
/**
* Cluster name
* @type {string}
* @memberof PostApiV4AdminClustersAddRequest
*/
'name': string;
/**
* Determines if cluster is active or not, defaults to true
* @type {boolean}
* @memberof PostApiV4AdminClustersAddRequest
*/
'enabled'?: boolean;
/**
* The associated environment to the cluster
* @type {string}
* @memberof PostApiV4AdminClustersAddRequest
*/
'environment_scope'?: string;
/**
* Deploy each environment to a separate Kubernetes namespace
* @type {boolean}
* @memberof PostApiV4AdminClustersAddRequest
*/
'namespace_per_environment'?: boolean;
/**
* Cluster base domain
* @type {string}
* @memberof PostApiV4AdminClustersAddRequest
*/
'domain'?: string;
/**
* The ID of the management project
* @type {number}
* @memberof PostApiV4AdminClustersAddRequest
*/
'management_project_id'?: number;
/**
* Determines if GitLab will manage namespaces and service accounts for this cluster, defaults to true
* @type {boolean}
* @memberof PostApiV4AdminClustersAddRequest
*/
'managed'?: boolean;
/**
* URL to access the Kubernetes API
* @type {string}
* @memberof PostApiV4AdminClustersAddRequest
*/
'platform_kubernetes_attributes[api_url]': string;
/**
* Token to authenticate against Kubernetes
* @type {string}
* @memberof PostApiV4AdminClustersAddRequest
*/
'platform_kubernetes_attributes[token]': string;
/**
* TLS certificate (needed if API is using a self-signed TLS certificate)
* @type {string}
* @memberof PostApiV4AdminClustersAddRequest
*/
'platform_kubernetes_attributes[ca_cert]'?: string;
/**
* Unique namespace related to Project
* @type {string}
* @memberof PostApiV4AdminClustersAddRequest
*/
'platform_kubernetes_attributes[namespace]'?: string;
/**
* Cluster authorization type, defaults to RBAC
* @type {string}
* @memberof PostApiV4AdminClustersAddRequest
*/
'platform_kubernetes_attributes[authorization_type]'?: PostApiV4AdminClustersAddRequestPlatformKubernetesAttributesAuthorizationTypeEnum;
}
export declare const PostApiV4AdminClustersAddRequestPlatformKubernetesAttributesAuthorizationTypeEnum: {
readonly UnknownAuthorization: "unknown_authorization";
readonly Rbac: "rbac";
readonly Abac: "abac";
};
export type PostApiV4AdminClustersAddRequestPlatformKubernetesAttributesAuthorizationTypeEnum = typeof PostApiV4AdminClustersAddRequestPlatformKubernetesAttributesAuthorizationTypeEnum[keyof typeof PostApiV4AdminClustersAddRequestPlatformKubernetesAttributesAuthorizationTypeEnum];
/**
*
* @export
* @interface PostApiV4ApplicationsRequest
*/
export interface PostApiV4ApplicationsRequest {
/**
* Name of the application.
* @type {string}
* @memberof PostApiV4ApplicationsRequest
*/
'name': string;
/**
* Redirect URI of the application.
* @type {string}
* @memberof PostApiV4ApplicationsRequest
*/
'redirect_uri': string;
/**
* Scopes of the application. You can specify multiple scopes by separating\\ each scope using a space
* @type {string}
* @memberof PostApiV4ApplicationsRequest
*/
'scopes': string;
/**
* The application is used where the client secret can be kept confidential. Native mobile apps \\ and Single Page Apps are considered non-confidential. Defaults to true if not supplied
* @type {boolean}
* @memberof PostApiV4ApplicationsRequest
*/
'confidential'?: boolean;
}
/**
*
* @export
* @interface PostApiV4BroadcastMessagesRequest
*/
export interface PostApiV4BroadcastMessagesRequest {
/**
* Message to display
* @type {string}
* @memberof PostApiV4BroadcastMessagesRequest
*/
'message': string;
/**
* Starting time
* @type {string}
* @memberof PostApiV4BroadcastMessagesRequest
*/
'starts_at'?: string;
/**
* Ending time
* @type {string}
* @memberof PostApiV4BroadcastMessagesRequest
*/
'ends_at'?: string;
/**
* Background color
* @type {string}
* @memberof PostApiV4BroadcastMessagesRequest
*/
'color'?: string;
/**
* Foreground color
* @type {string}
* @memberof PostApiV4BroadcastMessagesRequest
*/
'font'?: string;
/**
* Target user roles
* @type {Array}
* @memberof PostApiV4BroadcastMessagesRequest
*/
'target_access_levels'?: Array;
/**
* Target path
* @type {string}
* @memberof PostApiV4BroadcastMessagesRequest
*/
'target_path'?: string;
/**
* Broadcast type. Defaults to banner
* @type {string}
* @memberof PostApiV4BroadcastMessagesRequest
*/
'broadcast_type'?: PostApiV4BroadcastMessagesRequestBroadcastTypeEnum;
/**
* Is dismissable
* @type {boolean}
* @memberof PostApiV4BroadcastMessagesRequest
*/
'dismissable'?: boolean;
}
export declare const PostApiV4BroadcastMessagesRequestTargetAccessLevelsEnum: {
readonly NUMBER_10: 10;
readonly NUMBER_20: 20;
readonly NUMBER_30: 30;
readonly NUMBER_40: 40;
readonly NUMBER_50: 50;
};
export type PostApiV4BroadcastMessagesRequestTargetAccessLevelsEnum = typeof PostApiV4BroadcastMessagesRequestTargetAccessLevelsEnum[keyof typeof PostApiV4BroadcastMessagesRequestTargetAccessLevelsEnum];
export declare const PostApiV4BroadcastMessagesRequestBroadcastTypeEnum: {
readonly Banner: "banner";
readonly Notification: "notification";
};
export type PostApiV4BroadcastMessagesRequestBroadcastTypeEnum = typeof PostApiV4BroadcastMessagesRequestBroadcastTypeEnum[keyof typeof PostApiV4BroadcastMessagesRequestBroadcastTypeEnum];
/**
*
* @export
* @interface PostApiV4GroupsIdBadgesRequest
*/
export interface PostApiV4GroupsIdBadgesRequest {
/**
* URL of the badge link
* @type {string}
* @memberof PostApiV4GroupsIdBadgesRequest
*/
'link_url': string;
/**
* URL of the badge image
* @type {string}
* @memberof PostApiV4GroupsIdBadgesRequest
*/
'image_url': string;
/**
* Name for the badge
* @type {string}
* @memberof PostApiV4GroupsIdBadgesRequest
*/
'name'?: string;
}
/**
*
* @export
* @interface PutApiV4AdminBatchedBackgroundMigrationsIdResumeRequest
*/
export interface PutApiV4AdminBatchedBackgroundMigrationsIdResumeRequest {
/**
* The name of the database
* @type {string}
* @memberof PutApiV4AdminBatchedBackgroundMigrationsIdResumeRequest
*/
'database'?: PutApiV4AdminBatchedBackgroundMigrationsIdResumeRequestDatabaseEnum;
}
export declare const PutApiV4AdminBatchedBackgroundMigrationsIdResumeRequestDatabaseEnum: {
readonly Main: "main";
readonly Ci: "ci";
readonly Embedding: "embedding";
readonly MainClusterwide: "main_clusterwide";
readonly Geo: "geo";
};
export type PutApiV4AdminBatchedBackgroundMigrationsIdResumeRequestDatabaseEnum = typeof PutApiV4AdminBatchedBackgroundMigrationsIdResumeRequestDatabaseEnum[keyof typeof PutApiV4AdminBatchedBackgroundMigrationsIdResumeRequestDatabaseEnum];
/**
*
* @export
* @interface PutApiV4AdminCiVariablesKeyRequest
*/
export interface PutApiV4AdminCiVariablesKeyRequest {
/**
* The value of a variable
* @type {string}
* @memberof PutApiV4AdminCiVariablesKeyRequest
*/
'value'?: string;
/**
* Whether the variable is protected
* @type {boolean}
* @memberof PutApiV4AdminCiVariablesKeyRequest
*/
'protected'?: boolean;
/**
* Whether the variable is masked
* @type {boolean}
* @memberof PutApiV4AdminCiVariablesKeyRequest
*/
'masked'?: boolean;
/**
* Whether the variable will be expanded
* @type {boolean}
* @memberof PutApiV4AdminCiVariablesKeyRequest
*/
'raw'?: boolean;
/**
* The type of a variable. Available types are: env_var (default) and file
* @type {string}
* @memberof PutApiV4AdminCiVariablesKeyRequest
*/
'variable_type'?: PutApiV4AdminCiVariablesKeyRequestVariableTypeEnum;
}
export declare const PutApiV4AdminCiVariablesKeyRequestVariableTypeEnum: {
readonly EnvVar: "env_var";
readonly File: "file";
};
export type PutApiV4AdminCiVariablesKeyRequestVariableTypeEnum = typeof PutApiV4AdminCiVariablesKeyRequestVariableTypeEnum[keyof typeof PutApiV4AdminCiVariablesKeyRequestVariableTypeEnum];
/**
*
* @export
* @interface PutApiV4AdminClustersClusterIdRequest
*/
export interface PutApiV4AdminClustersClusterIdRequest {
/**
* Cluster name
* @type {string}
* @memberof PutApiV4AdminClustersClusterIdRequest
*/
'name'?: string;
/**
* Enable or disable Gitlab\'s connection to your Kubernetes cluster
* @type {boolean}
* @memberof PutApiV4AdminClustersClusterIdRequest
*/
'enabled'?: boolean;
/**
* The associated environment to the cluster
* @type {string}
* @memberof PutApiV4AdminClustersClusterIdRequest
*/
'environment_scope'?: string;
/**
* Deploy each environment to a separate Kubernetes namespace
* @type {boolean}
* @memberof PutApiV4AdminClustersClusterIdRequest
*/
'namespace_per_environment'?: boolean;
/**
* Cluster base domain
* @type {string}
* @memberof PutApiV4AdminClustersClusterIdRequest
*/
'domain'?: string;
/**
* The ID of the management project
* @type {number}
* @memberof PutApiV4AdminClustersClusterIdRequest
*/
'management_project_id'?: number;
/**
* Determines if GitLab will manage namespaces and service accounts for this cluster
* @type {boolean}
* @memberof PutApiV4AdminClustersClusterIdRequest
*/
'managed'?: boolean;
/**
* URL to access the Kubernetes API
* @type {string}
* @memberof PutApiV4AdminClustersClusterIdRequest
*/
'platform_kubernetes_attributes[api_url]'?: string;
/**
* Token to authenticate against Kubernetes
* @type {string}
* @memberof PutApiV4AdminClustersClusterIdRequest
*/
'platform_kubernetes_attributes[token]'?: string;
/**
* TLS certificate (needed if API is using a self-signed TLS certificate)
* @type {string}
* @memberof PutApiV4AdminClustersClusterIdRequest
*/
'platform_kubernetes_attributes[ca_cert]'?: string;
/**
* Unique namespace related to Project
* @type {string}
* @memberof PutApiV4AdminClustersClusterIdRequest
*/
'platform_kubernetes_attributes[namespace]'?: string;
}
/**
*
* @export
* @interface PutApiV4ApplicationPlanLimitsRequest
*/
export interface PutApiV4ApplicationPlanLimitsRequest {
/**
* Name of the plan to update
* @type {string}
* @memberof PutApiV4ApplicationPlanLimitsRequest
*/
'plan_name': PutApiV4ApplicationPlanLimitsRequestPlanNameEnum;
/**
* Maximum number of jobs in a single pipeline
* @type {number}
* @memberof PutApiV4ApplicationPlanLimitsRequest
*/
'ci_pipeline_size'?: number;
/**
* Total number of jobs in currently active pipelines
* @type {number}
* @memberof PutApiV4ApplicationPlanLimitsRequest
*/
'ci_active_jobs'?: number;
/**
* Maximum number of pipeline subscriptions to and from a project
* @type {number}
* @memberof PutApiV4ApplicationPlanLimitsRequest
*/
'ci_project_subscriptions'?: number;
/**
* Maximum number of pipeline schedules
* @type {number}
* @memberof PutApiV4ApplicationPlanLimitsRequest
*/
'ci_pipeline_schedules'?: number;
/**
* Maximum number of needs dependencies that a job can have
* @type {number}
* @memberof PutApiV4ApplicationPlanLimitsRequest
*/
'ci_needs_size_limit'?: number;
/**
* Maximum number of runners registered per group
* @type {number}
* @memberof PutApiV4ApplicationPlanLimitsRequest
*/
'ci_registered_group_runners'?: number;
/**
* Maximum number of runners registered per project
* @type {number}
* @memberof PutApiV4ApplicationPlanLimitsRequest
*/
'ci_registered_project_runners'?: number;
/**
* Maximum Conan package file size in bytes
* @type {number}
* @memberof PutApiV4ApplicationPlanLimitsRequest
*/
'conan_max_file_size'?: number;
/**
* Maximum storage size for the root namespace enforcement in MiB
* @type {number}
* @memberof PutApiV4ApplicationPlanLimitsRequest
*/
'enforcement_limit'?: number;
/**
* Maximum generic package file size in bytes
* @type {number}
* @memberof PutApiV4ApplicationPlanLimitsRequest
*/
'generic_packages_max_file_size'?: number;
/**
* Maximum Helm chart file size in bytes
* @type {number}
* @memberof PutApiV4ApplicationPlanLimitsRequest
*/
'helm_max_file_size'?: number;
/**
* Maximum Maven package file size in bytes
* @type {number}
* @memberof PutApiV4ApplicationPlanLimitsRequest
*/
'maven_max_file_size'?: number;
/**
* Maximum storage size for the root namespace notifications in MiB
* @type {number}
* @memberof PutApiV4ApplicationPlanLimitsRequest
*/
'notification_limit'?: number;
/**
* Maximum NPM package file size in bytes
* @type {number}
* @memberof PutApiV4ApplicationPlanLimitsRequest
*/
'npm_max_file_size'?: number;
/**
* Maximum NuGet package file size in bytes
* @type {number}
* @memberof PutApiV4ApplicationPlanLimitsRequest
*/
'nuget_max_file_size'?: number;
/**
* Maximum PyPI package file size in bytes
* @type {number}
* @memberof PutApiV4ApplicationPlanLimitsRequest
*/
'pypi_max_file_size'?: number;
/**
* Maximum Terraform Module package file size in bytes
* @type {number}
* @memberof PutApiV4ApplicationPlanLimitsRequest
*/
'terraform_module_max_file_size'?: number;
/**
* Maximum storage size for the root namespace in MiB
* @type {number}
* @memberof PutApiV4ApplicationPlanLimitsRequest
*/
'storage_size_limit'?: number;
/**
* Maximum number of downstream pipelines in a pipeline\'s hierarchy tree
* @type {number}
* @memberof PutApiV4ApplicationPlanLimitsRequest
*/
'pipeline_hierarchy_size'?: number;
}
export declare const PutApiV4ApplicationPlanLimitsRequestPlanNameEnum: {
readonly Default: "default";
readonly Free: "free";
readonly Bronze: "bronze";
readonly Silver: "silver";
readonly Premium: "premium";
readonly Gold: "gold";
readonly Ultimate: "ultimate";
readonly UltimateTrial: "ultimate_trial";
readonly PremiumTrial: "premium_trial";
readonly Opensource: "opensource";
};
export type PutApiV4ApplicationPlanLimitsRequestPlanNameEnum = typeof PutApiV4ApplicationPlanLimitsRequestPlanNameEnum[keyof typeof PutApiV4ApplicationPlanLimitsRequestPlanNameEnum];
/**
*
* @export
* @interface PutApiV4BroadcastMessagesIdRequest
*/
export interface PutApiV4BroadcastMessagesIdRequest {
/**
* Message to display
* @type {string}
* @memberof PutApiV4BroadcastMessagesIdRequest
*/
'message'?: string;
/**
* Starting time
* @type {string}
* @memberof PutApiV4BroadcastMessagesIdRequest
*/
'starts_at'?: string;
/**
* Ending time
* @type {string}
* @memberof PutApiV4BroadcastMessagesIdRequest
*/
'ends_at'?: string;
/**
* Background color
* @type {string}
* @memberof PutApiV4BroadcastMessagesIdRequest
*/
'color'?: string;
/**
* Foreground color
* @type {string}
* @memberof PutApiV4BroadcastMessagesIdRequest
*/
'font'?: string;
/**
* Target user roles
* @type {Array}
* @memberof PutApiV4BroadcastMessagesIdRequest
*/
'target_access_levels'?: Array;
/**
* Target path
* @type {string}
* @memberof PutApiV4BroadcastMessagesIdRequest
*/
'target_path'?: string;
/**
* Broadcast Type
* @type {string}
* @memberof PutApiV4BroadcastMessagesIdRequest
*/
'broadcast_type'?: PutApiV4BroadcastMessagesIdRequestBroadcastTypeEnum;
/**
* Is dismissable
* @type {boolean}
* @memberof PutApiV4BroadcastMessagesIdRequest
*/
'dismissable'?: boolean;
}
export declare const PutApiV4BroadcastMessagesIdRequestTargetAccessLevelsEnum: {
readonly NUMBER_10: 10;
readonly NUMBER_20: 20;
readonly NUMBER_30: 30;
readonly NUMBER_40: 40;
readonly NUMBER_50: 50;
};
export type PutApiV4BroadcastMessagesIdRequestTargetAccessLevelsEnum = typeof PutApiV4BroadcastMessagesIdRequestTargetAccessLevelsEnum[keyof typeof PutApiV4BroadcastMessagesIdRequestTargetAccessLevelsEnum];
export declare const PutApiV4BroadcastMessagesIdRequestBroadcastTypeEnum: {
readonly Banner: "banner";
readonly Notification: "notification";
};
export type PutApiV4BroadcastMessagesIdRequestBroadcastTypeEnum = typeof PutApiV4BroadcastMessagesIdRequestBroadcastTypeEnum[keyof typeof PutApiV4BroadcastMessagesIdRequestBroadcastTypeEnum];
/**
*
* @export
* @interface PutApiV4GroupsIdAccessRequestsUserIdApproveRequest
*/
export interface PutApiV4GroupsIdAccessRequestsUserIdApproveRequest {
/**
* A valid access level (defaults: `30`, the Developer role)
* @type {number}
* @memberof PutApiV4GroupsIdAccessRequestsUserIdApproveRequest
*/
'access_level'?: number;
}
/**
*
* @export
* @interface PutApiV4GroupsIdBadgesBadgeIdRequest
*/
export interface PutApiV4GroupsIdBadgesBadgeIdRequest {
/**
* URL of the badge link
* @type {string}
* @memberof PutApiV4GroupsIdBadgesBadgeIdRequest
*/
'link_url'?: string;
/**
* URL of the badge image
* @type {string}
* @memberof PutApiV4GroupsIdBadgesBadgeIdRequest
*/
'image_url'?: string;
/**
* Name for the badge
* @type {string}
* @memberof PutApiV4GroupsIdBadgesBadgeIdRequest
*/
'name'?: string;
}
/**
*
* @export
* @interface PutApiV4ProjectsIdRepositoryBranchesBranchProtectRequest
*/
export interface PutApiV4ProjectsIdRepositoryBranchesBranchProtectRequest {
/**
* Flag if developers can push to that branch
* @type {boolean}
* @memberof PutApiV4ProjectsIdRepositoryBranchesBranchProtectRequest
*/
'developers_can_push'?: boolean;
/**
* Flag if developers can merge to that branch
* @type {boolean}
* @memberof PutApiV4ProjectsIdRepositoryBranchesBranchProtectRequest
*/
'developers_can_merge'?: boolean;
}
/**
* AccessRequestsApi - axios parameter creator
* @export
*/
export declare const AccessRequestsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* This feature was introduced in GitLab 8.11.
* @summary Denies an access request for the given user.
* @param {string} id The ID or URL-encoded path of the group owned by the authenticated user
* @param {number} userId The user ID of the access requester
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteApiV4GroupsIdAccessRequestsUserId: (id: string, userId: number, options?: RawAxiosRequestConfig) => Promise;
/**
* This feature was introduced in GitLab 8.11.
* @summary Denies an access request for the given user.
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {number} userId The user ID of the access requester
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteApiV4ProjectsIdAccessRequestsUserId: (id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, userId: number, options?: RawAxiosRequestConfig) => Promise;
/**
* This feature was introduced in GitLab 8.11.
* @summary Gets a list of access requests for a group.
* @param {string} id The ID or URL-encoded path of the group owned by the authenticated user
* @param {number} [page] Current page number
* @param {number} [perPage] Number of items per page
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4GroupsIdAccessRequests: (id: string, page?: number, perPage?: number, options?: RawAxiosRequestConfig) => Promise;
/**
* This feature was introduced in GitLab 8.11.
* @summary Gets a list of access requests for a project.
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {number} [page] Current page number
* @param {number} [perPage] Number of items per page
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4ProjectsIdAccessRequests: (id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, page?: number, perPage?: number, options?: RawAxiosRequestConfig) => Promise;
/**
* This feature was introduced in GitLab 8.11.
* @summary Requests access for the authenticated user to a group.
* @param {string} id The ID or URL-encoded path of the group owned by the authenticated user
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postApiV4GroupsIdAccessRequests: (id: string, options?: RawAxiosRequestConfig) => Promise;
/**
* This feature was introduced in GitLab 8.11.
* @summary Requests access for the authenticated user to a project.
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postApiV4ProjectsIdAccessRequests: (id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, options?: RawAxiosRequestConfig) => Promise;
/**
* This feature was introduced in GitLab 8.11.
* @summary Approves an access request for the given user.
* @param {string} id The ID or URL-encoded path of the group owned by the authenticated user
* @param {number} userId The user ID of the access requester
* @param {PutApiV4GroupsIdAccessRequestsUserIdApproveRequest} [putApiV4GroupsIdAccessRequestsUserIdApproveRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
putApiV4GroupsIdAccessRequestsUserIdApprove: (id: string, userId: number, putApiV4GroupsIdAccessRequestsUserIdApproveRequest?: PutApiV4GroupsIdAccessRequestsUserIdApproveRequest, options?: RawAxiosRequestConfig) => Promise;
/**
* This feature was introduced in GitLab 8.11.
* @summary Approves an access request for the given user.
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {number} userId The user ID of the access requester
* @param {PutApiV4GroupsIdAccessRequestsUserIdApproveRequest} [putApiV4GroupsIdAccessRequestsUserIdApproveRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
putApiV4ProjectsIdAccessRequestsUserIdApprove: (id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, userId: number, putApiV4GroupsIdAccessRequestsUserIdApproveRequest?: PutApiV4GroupsIdAccessRequestsUserIdApproveRequest, options?: RawAxiosRequestConfig) => Promise;
};
/**
* AccessRequestsApi - functional programming interface
* @export
*/
export declare const AccessRequestsApiFp: (configuration?: Configuration) => {
/**
* This feature was introduced in GitLab 8.11.
* @summary Denies an access request for the given user.
* @param {string} id The ID or URL-encoded path of the group owned by the authenticated user
* @param {number} userId The user ID of the access requester
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteApiV4GroupsIdAccessRequestsUserId(id: string, userId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* This feature was introduced in GitLab 8.11.
* @summary Denies an access request for the given user.
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {number} userId The user ID of the access requester
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteApiV4ProjectsIdAccessRequestsUserId(id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, userId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* This feature was introduced in GitLab 8.11.
* @summary Gets a list of access requests for a group.
* @param {string} id The ID or URL-encoded path of the group owned by the authenticated user
* @param {number} [page] Current page number
* @param {number} [perPage] Number of items per page
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4GroupsIdAccessRequests(id: string, page?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* This feature was introduced in GitLab 8.11.
* @summary Gets a list of access requests for a project.
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {number} [page] Current page number
* @param {number} [perPage] Number of items per page
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4ProjectsIdAccessRequests(id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, page?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* This feature was introduced in GitLab 8.11.
* @summary Requests access for the authenticated user to a group.
* @param {string} id The ID or URL-encoded path of the group owned by the authenticated user
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postApiV4GroupsIdAccessRequests(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* This feature was introduced in GitLab 8.11.
* @summary Requests access for the authenticated user to a project.
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postApiV4ProjectsIdAccessRequests(id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* This feature was introduced in GitLab 8.11.
* @summary Approves an access request for the given user.
* @param {string} id The ID or URL-encoded path of the group owned by the authenticated user
* @param {number} userId The user ID of the access requester
* @param {PutApiV4GroupsIdAccessRequestsUserIdApproveRequest} [putApiV4GroupsIdAccessRequestsUserIdApproveRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
putApiV4GroupsIdAccessRequestsUserIdApprove(id: string, userId: number, putApiV4GroupsIdAccessRequestsUserIdApproveRequest?: PutApiV4GroupsIdAccessRequestsUserIdApproveRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* This feature was introduced in GitLab 8.11.
* @summary Approves an access request for the given user.
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {number} userId The user ID of the access requester
* @param {PutApiV4GroupsIdAccessRequestsUserIdApproveRequest} [putApiV4GroupsIdAccessRequestsUserIdApproveRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
putApiV4ProjectsIdAccessRequestsUserIdApprove(id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, userId: number, putApiV4GroupsIdAccessRequestsUserIdApproveRequest?: PutApiV4GroupsIdAccessRequestsUserIdApproveRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* AccessRequestsApi - factory interface
* @export
*/
export declare const AccessRequestsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* This feature was introduced in GitLab 8.11.
* @summary Denies an access request for the given user.
* @param {AccessRequestsApiDeleteApiV4GroupsIdAccessRequestsUserIdRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteApiV4GroupsIdAccessRequestsUserId(requestParameters: AccessRequestsApiDeleteApiV4GroupsIdAccessRequestsUserIdRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* This feature was introduced in GitLab 8.11.
* @summary Denies an access request for the given user.
* @param {AccessRequestsApiDeleteApiV4ProjectsIdAccessRequestsUserIdRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteApiV4ProjectsIdAccessRequestsUserId(requestParameters: AccessRequestsApiDeleteApiV4ProjectsIdAccessRequestsUserIdRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* This feature was introduced in GitLab 8.11.
* @summary Gets a list of access requests for a group.
* @param {AccessRequestsApiGetApiV4GroupsIdAccessRequestsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4GroupsIdAccessRequests(requestParameters: AccessRequestsApiGetApiV4GroupsIdAccessRequestsRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* This feature was introduced in GitLab 8.11.
* @summary Gets a list of access requests for a project.
* @param {AccessRequestsApiGetApiV4ProjectsIdAccessRequestsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4ProjectsIdAccessRequests(requestParameters: AccessRequestsApiGetApiV4ProjectsIdAccessRequestsRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* This feature was introduced in GitLab 8.11.
* @summary Requests access for the authenticated user to a group.
* @param {AccessRequestsApiPostApiV4GroupsIdAccessRequestsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postApiV4GroupsIdAccessRequests(requestParameters: AccessRequestsApiPostApiV4GroupsIdAccessRequestsRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* This feature was introduced in GitLab 8.11.
* @summary Requests access for the authenticated user to a project.
* @param {AccessRequestsApiPostApiV4ProjectsIdAccessRequestsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postApiV4ProjectsIdAccessRequests(requestParameters: AccessRequestsApiPostApiV4ProjectsIdAccessRequestsRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* This feature was introduced in GitLab 8.11.
* @summary Approves an access request for the given user.
* @param {AccessRequestsApiPutApiV4GroupsIdAccessRequestsUserIdApproveRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
putApiV4GroupsIdAccessRequestsUserIdApprove(requestParameters: AccessRequestsApiPutApiV4GroupsIdAccessRequestsUserIdApproveRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* This feature was introduced in GitLab 8.11.
* @summary Approves an access request for the given user.
* @param {AccessRequestsApiPutApiV4ProjectsIdAccessRequestsUserIdApproveRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
putApiV4ProjectsIdAccessRequestsUserIdApprove(requestParameters: AccessRequestsApiPutApiV4ProjectsIdAccessRequestsUserIdApproveRequest, options?: RawAxiosRequestConfig): AxiosPromise;
};
/**
* Request parameters for deleteApiV4GroupsIdAccessRequestsUserId operation in AccessRequestsApi.
* @export
* @interface AccessRequestsApiDeleteApiV4GroupsIdAccessRequestsUserIdRequest
*/
export interface AccessRequestsApiDeleteApiV4GroupsIdAccessRequestsUserIdRequest {
/**
* The ID or URL-encoded path of the group owned by the authenticated user
* @type {string}
* @memberof AccessRequestsApiDeleteApiV4GroupsIdAccessRequestsUserId
*/
readonly id: string;
/**
* The user ID of the access requester
* @type {number}
* @memberof AccessRequestsApiDeleteApiV4GroupsIdAccessRequestsUserId
*/
readonly userId: number;
}
/**
* Request parameters for deleteApiV4ProjectsIdAccessRequestsUserId operation in AccessRequestsApi.
* @export
* @interface AccessRequestsApiDeleteApiV4ProjectsIdAccessRequestsUserIdRequest
*/
export interface AccessRequestsApiDeleteApiV4ProjectsIdAccessRequestsUserIdRequest {
/**
* The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @type {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter}
* @memberof AccessRequestsApiDeleteApiV4ProjectsIdAccessRequestsUserId
*/
readonly id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter;
/**
* The user ID of the access requester
* @type {number}
* @memberof AccessRequestsApiDeleteApiV4ProjectsIdAccessRequestsUserId
*/
readonly userId: number;
}
/**
* Request parameters for getApiV4GroupsIdAccessRequests operation in AccessRequestsApi.
* @export
* @interface AccessRequestsApiGetApiV4GroupsIdAccessRequestsRequest
*/
export interface AccessRequestsApiGetApiV4GroupsIdAccessRequestsRequest {
/**
* The ID or URL-encoded path of the group owned by the authenticated user
* @type {string}
* @memberof AccessRequestsApiGetApiV4GroupsIdAccessRequests
*/
readonly id: string;
/**
* Current page number
* @type {number}
* @memberof AccessRequestsApiGetApiV4GroupsIdAccessRequests
*/
readonly page?: number;
/**
* Number of items per page
* @type {number}
* @memberof AccessRequestsApiGetApiV4GroupsIdAccessRequests
*/
readonly perPage?: number;
}
/**
* Request parameters for getApiV4ProjectsIdAccessRequests operation in AccessRequestsApi.
* @export
* @interface AccessRequestsApiGetApiV4ProjectsIdAccessRequestsRequest
*/
export interface AccessRequestsApiGetApiV4ProjectsIdAccessRequestsRequest {
/**
* The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @type {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter}
* @memberof AccessRequestsApiGetApiV4ProjectsIdAccessRequests
*/
readonly id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter;
/**
* Current page number
* @type {number}
* @memberof AccessRequestsApiGetApiV4ProjectsIdAccessRequests
*/
readonly page?: number;
/**
* Number of items per page
* @type {number}
* @memberof AccessRequestsApiGetApiV4ProjectsIdAccessRequests
*/
readonly perPage?: number;
}
/**
* Request parameters for postApiV4GroupsIdAccessRequests operation in AccessRequestsApi.
* @export
* @interface AccessRequestsApiPostApiV4GroupsIdAccessRequestsRequest
*/
export interface AccessRequestsApiPostApiV4GroupsIdAccessRequestsRequest {
/**
* The ID or URL-encoded path of the group owned by the authenticated user
* @type {string}
* @memberof AccessRequestsApiPostApiV4GroupsIdAccessRequests
*/
readonly id: string;
}
/**
* Request parameters for postApiV4ProjectsIdAccessRequests operation in AccessRequestsApi.
* @export
* @interface AccessRequestsApiPostApiV4ProjectsIdAccessRequestsRequest
*/
export interface AccessRequestsApiPostApiV4ProjectsIdAccessRequestsRequest {
/**
* The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @type {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter}
* @memberof AccessRequestsApiPostApiV4ProjectsIdAccessRequests
*/
readonly id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter;
}
/**
* Request parameters for putApiV4GroupsIdAccessRequestsUserIdApprove operation in AccessRequestsApi.
* @export
* @interface AccessRequestsApiPutApiV4GroupsIdAccessRequestsUserIdApproveRequest
*/
export interface AccessRequestsApiPutApiV4GroupsIdAccessRequestsUserIdApproveRequest {
/**
* The ID or URL-encoded path of the group owned by the authenticated user
* @type {string}
* @memberof AccessRequestsApiPutApiV4GroupsIdAccessRequestsUserIdApprove
*/
readonly id: string;
/**
* The user ID of the access requester
* @type {number}
* @memberof AccessRequestsApiPutApiV4GroupsIdAccessRequestsUserIdApprove
*/
readonly userId: number;
/**
*
* @type {PutApiV4GroupsIdAccessRequestsUserIdApproveRequest}
* @memberof AccessRequestsApiPutApiV4GroupsIdAccessRequestsUserIdApprove
*/
readonly putApiV4GroupsIdAccessRequestsUserIdApproveRequest?: PutApiV4GroupsIdAccessRequestsUserIdApproveRequest;
}
/**
* Request parameters for putApiV4ProjectsIdAccessRequestsUserIdApprove operation in AccessRequestsApi.
* @export
* @interface AccessRequestsApiPutApiV4ProjectsIdAccessRequestsUserIdApproveRequest
*/
export interface AccessRequestsApiPutApiV4ProjectsIdAccessRequestsUserIdApproveRequest {
/**
* The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @type {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter}
* @memberof AccessRequestsApiPutApiV4ProjectsIdAccessRequestsUserIdApprove
*/
readonly id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter;
/**
* The user ID of the access requester
* @type {number}
* @memberof AccessRequestsApiPutApiV4ProjectsIdAccessRequestsUserIdApprove
*/
readonly userId: number;
/**
*
* @type {PutApiV4GroupsIdAccessRequestsUserIdApproveRequest}
* @memberof AccessRequestsApiPutApiV4ProjectsIdAccessRequestsUserIdApprove
*/
readonly putApiV4GroupsIdAccessRequestsUserIdApproveRequest?: PutApiV4GroupsIdAccessRequestsUserIdApproveRequest;
}
/**
* AccessRequestsApi - object-oriented interface
* @export
* @class AccessRequestsApi
* @extends {BaseAPI}
*/
export declare class AccessRequestsApi extends BaseAPI {
/**
* This feature was introduced in GitLab 8.11.
* @summary Denies an access request for the given user.
* @param {AccessRequestsApiDeleteApiV4GroupsIdAccessRequestsUserIdRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof AccessRequestsApi
*/
deleteApiV4GroupsIdAccessRequestsUserId(requestParameters: AccessRequestsApiDeleteApiV4GroupsIdAccessRequestsUserIdRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* This feature was introduced in GitLab 8.11.
* @summary Denies an access request for the given user.
* @param {AccessRequestsApiDeleteApiV4ProjectsIdAccessRequestsUserIdRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof AccessRequestsApi
*/
deleteApiV4ProjectsIdAccessRequestsUserId(requestParameters: AccessRequestsApiDeleteApiV4ProjectsIdAccessRequestsUserIdRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* This feature was introduced in GitLab 8.11.
* @summary Gets a list of access requests for a group.
* @param {AccessRequestsApiGetApiV4GroupsIdAccessRequestsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof AccessRequestsApi
*/
getApiV4GroupsIdAccessRequests(requestParameters: AccessRequestsApiGetApiV4GroupsIdAccessRequestsRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* This feature was introduced in GitLab 8.11.
* @summary Gets a list of access requests for a project.
* @param {AccessRequestsApiGetApiV4ProjectsIdAccessRequestsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof AccessRequestsApi
*/
getApiV4ProjectsIdAccessRequests(requestParameters: AccessRequestsApiGetApiV4ProjectsIdAccessRequestsRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* This feature was introduced in GitLab 8.11.
* @summary Requests access for the authenticated user to a group.
* @param {AccessRequestsApiPostApiV4GroupsIdAccessRequestsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof AccessRequestsApi
*/
postApiV4GroupsIdAccessRequests(requestParameters: AccessRequestsApiPostApiV4GroupsIdAccessRequestsRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* This feature was introduced in GitLab 8.11.
* @summary Requests access for the authenticated user to a project.
* @param {AccessRequestsApiPostApiV4ProjectsIdAccessRequestsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof AccessRequestsApi
*/
postApiV4ProjectsIdAccessRequests(requestParameters: AccessRequestsApiPostApiV4ProjectsIdAccessRequestsRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* This feature was introduced in GitLab 8.11.
* @summary Approves an access request for the given user.
* @param {AccessRequestsApiPutApiV4GroupsIdAccessRequestsUserIdApproveRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof AccessRequestsApi
*/
putApiV4GroupsIdAccessRequestsUserIdApprove(requestParameters: AccessRequestsApiPutApiV4GroupsIdAccessRequestsUserIdApproveRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* This feature was introduced in GitLab 8.11.
* @summary Approves an access request for the given user.
* @param {AccessRequestsApiPutApiV4ProjectsIdAccessRequestsUserIdApproveRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof AccessRequestsApi
*/
putApiV4ProjectsIdAccessRequestsUserIdApprove(requestParameters: AccessRequestsApiPutApiV4ProjectsIdAccessRequestsUserIdApproveRequest, options?: RawAxiosRequestConfig): Promise>;
}
/**
* AdminApi - axios parameter creator
* @export
*/
export declare const AdminApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Retrieve dictionary details
* @param {GetApiV4AdminDatabasesDatabaseNameDictionaryTablesTableNameDatabaseNameEnum} databaseName The database name
* @param {string} tableName The table name
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4AdminDatabasesDatabaseNameDictionaryTablesTableName: (databaseName: GetApiV4AdminDatabasesDatabaseNameDictionaryTablesTableNameDatabaseNameEnum, tableName: string, options?: RawAxiosRequestConfig) => Promise;
};
/**
* AdminApi - functional programming interface
* @export
*/
export declare const AdminApiFp: (configuration?: Configuration) => {
/**
* Retrieve dictionary details
* @param {GetApiV4AdminDatabasesDatabaseNameDictionaryTablesTableNameDatabaseNameEnum} databaseName The database name
* @param {string} tableName The table name
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4AdminDatabasesDatabaseNameDictionaryTablesTableName(databaseName: GetApiV4AdminDatabasesDatabaseNameDictionaryTablesTableNameDatabaseNameEnum, tableName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* AdminApi - factory interface
* @export
*/
export declare const AdminApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Retrieve dictionary details
* @param {AdminApiGetApiV4AdminDatabasesDatabaseNameDictionaryTablesTableNameRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4AdminDatabasesDatabaseNameDictionaryTablesTableName(requestParameters: AdminApiGetApiV4AdminDatabasesDatabaseNameDictionaryTablesTableNameRequest, options?: RawAxiosRequestConfig): AxiosPromise;
};
/**
* Request parameters for getApiV4AdminDatabasesDatabaseNameDictionaryTablesTableName operation in AdminApi.
* @export
* @interface AdminApiGetApiV4AdminDatabasesDatabaseNameDictionaryTablesTableNameRequest
*/
export interface AdminApiGetApiV4AdminDatabasesDatabaseNameDictionaryTablesTableNameRequest {
/**
* The database name
* @type {'main' | 'ci'}
* @memberof AdminApiGetApiV4AdminDatabasesDatabaseNameDictionaryTablesTableName
*/
readonly databaseName: GetApiV4AdminDatabasesDatabaseNameDictionaryTablesTableNameDatabaseNameEnum;
/**
* The table name
* @type {string}
* @memberof AdminApiGetApiV4AdminDatabasesDatabaseNameDictionaryTablesTableName
*/
readonly tableName: string;
}
/**
* AdminApi - object-oriented interface
* @export
* @class AdminApi
* @extends {BaseAPI}
*/
export declare class AdminApi extends BaseAPI {
/**
* Retrieve dictionary details
* @param {AdminApiGetApiV4AdminDatabasesDatabaseNameDictionaryTablesTableNameRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof AdminApi
*/
getApiV4AdminDatabasesDatabaseNameDictionaryTablesTableName(requestParameters: AdminApiGetApiV4AdminDatabasesDatabaseNameDictionaryTablesTableNameRequest, options?: RawAxiosRequestConfig): Promise>;
}
/**
* @export
*/
export declare const GetApiV4AdminDatabasesDatabaseNameDictionaryTablesTableNameDatabaseNameEnum: {
readonly Main: "main";
readonly Ci: "ci";
};
export type GetApiV4AdminDatabasesDatabaseNameDictionaryTablesTableNameDatabaseNameEnum = typeof GetApiV4AdminDatabasesDatabaseNameDictionaryTablesTableNameDatabaseNameEnum[keyof typeof GetApiV4AdminDatabasesDatabaseNameDictionaryTablesTableNameDatabaseNameEnum];
/**
* AlertManagementApi - axios parameter creator
* @export
*/
export declare const AlertManagementApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Remove a metric image for an alert
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {number} alertIid The IID of the Alert
* @param {number} metricImageId The ID of metric image
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageId: (id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, alertIid: number, metricImageId: number, options?: RawAxiosRequestConfig) => Promise;
/**
* Metric Images for alert
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {number} alertIid The IID of the Alert
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImages: (id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, alertIid: number, options?: RawAxiosRequestConfig) => Promise;
/**
* Upload a metric image for an alert
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {number} alertIid The IID of the Alert
* @param {File} file The image file to be uploaded
* @param {string} [url] The url to view more metric info
* @param {string} [urlText] A description of the image or URL
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImages: (id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, alertIid: number, file: File, url?: string, urlText?: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Workhorse authorize metric image file upload
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {number} alertIid The IID of the Alert
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesAuthorize: (id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, alertIid: number, options?: RawAxiosRequestConfig) => Promise;
/**
* Update a metric image for an alert
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {number} alertIid The IID of the Alert
* @param {number} metricImageId The ID of metric image
* @param {string} [url] The url to view more metric info
* @param {string} [urlText] A description of the image or URL
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
putApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageId: (id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, alertIid: number, metricImageId: number, url?: string, urlText?: string, options?: RawAxiosRequestConfig) => Promise;
};
/**
* AlertManagementApi - functional programming interface
* @export
*/
export declare const AlertManagementApiFp: (configuration?: Configuration) => {
/**
* Remove a metric image for an alert
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {number} alertIid The IID of the Alert
* @param {number} metricImageId The ID of metric image
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageId(id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, alertIid: number, metricImageId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Metric Images for alert
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {number} alertIid The IID of the Alert
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImages(id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, alertIid: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>;
/**
* Upload a metric image for an alert
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {number} alertIid The IID of the Alert
* @param {File} file The image file to be uploaded
* @param {string} [url] The url to view more metric info
* @param {string} [urlText] A description of the image or URL
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImages(id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, alertIid: number, file: File, url?: string, urlText?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Workhorse authorize metric image file upload
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {number} alertIid The IID of the Alert
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesAuthorize(id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, alertIid: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Update a metric image for an alert
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {number} alertIid The IID of the Alert
* @param {number} metricImageId The ID of metric image
* @param {string} [url] The url to view more metric info
* @param {string} [urlText] A description of the image or URL
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
putApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageId(id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, alertIid: number, metricImageId: number, url?: string, urlText?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* AlertManagementApi - factory interface
* @export
*/
export declare const AlertManagementApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Remove a metric image for an alert
* @param {AlertManagementApiDeleteApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageIdRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageId(requestParameters: AlertManagementApiDeleteApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageIdRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Metric Images for alert
* @param {AlertManagementApiGetApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImages(requestParameters: AlertManagementApiGetApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesRequest, options?: RawAxiosRequestConfig): AxiosPromise>;
/**
* Upload a metric image for an alert
* @param {AlertManagementApiPostApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImages(requestParameters: AlertManagementApiPostApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Workhorse authorize metric image file upload
* @param {AlertManagementApiPostApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesAuthorizeRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesAuthorize(requestParameters: AlertManagementApiPostApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesAuthorizeRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Update a metric image for an alert
* @param {AlertManagementApiPutApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageIdRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
putApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageId(requestParameters: AlertManagementApiPutApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageIdRequest, options?: RawAxiosRequestConfig): AxiosPromise;
};
/**
* Request parameters for deleteApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageId operation in AlertManagementApi.
* @export
* @interface AlertManagementApiDeleteApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageIdRequest
*/
export interface AlertManagementApiDeleteApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageIdRequest {
/**
* The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @type {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter}
* @memberof AlertManagementApiDeleteApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageId
*/
readonly id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter;
/**
* The IID of the Alert
* @type {number}
* @memberof AlertManagementApiDeleteApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageId
*/
readonly alertIid: number;
/**
* The ID of metric image
* @type {number}
* @memberof AlertManagementApiDeleteApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageId
*/
readonly metricImageId: number;
}
/**
* Request parameters for getApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImages operation in AlertManagementApi.
* @export
* @interface AlertManagementApiGetApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesRequest
*/
export interface AlertManagementApiGetApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesRequest {
/**
* The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @type {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter}
* @memberof AlertManagementApiGetApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImages
*/
readonly id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter;
/**
* The IID of the Alert
* @type {number}
* @memberof AlertManagementApiGetApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImages
*/
readonly alertIid: number;
}
/**
* Request parameters for postApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImages operation in AlertManagementApi.
* @export
* @interface AlertManagementApiPostApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesRequest
*/
export interface AlertManagementApiPostApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesRequest {
/**
* The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @type {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter}
* @memberof AlertManagementApiPostApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImages
*/
readonly id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter;
/**
* The IID of the Alert
* @type {number}
* @memberof AlertManagementApiPostApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImages
*/
readonly alertIid: number;
/**
* The image file to be uploaded
* @type {File}
* @memberof AlertManagementApiPostApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImages
*/
readonly file: File;
/**
* The url to view more metric info
* @type {string}
* @memberof AlertManagementApiPostApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImages
*/
readonly url?: string;
/**
* A description of the image or URL
* @type {string}
* @memberof AlertManagementApiPostApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImages
*/
readonly urlText?: string;
}
/**
* Request parameters for postApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesAuthorize operation in AlertManagementApi.
* @export
* @interface AlertManagementApiPostApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesAuthorizeRequest
*/
export interface AlertManagementApiPostApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesAuthorizeRequest {
/**
* The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @type {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter}
* @memberof AlertManagementApiPostApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesAuthorize
*/
readonly id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter;
/**
* The IID of the Alert
* @type {number}
* @memberof AlertManagementApiPostApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesAuthorize
*/
readonly alertIid: number;
}
/**
* Request parameters for putApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageId operation in AlertManagementApi.
* @export
* @interface AlertManagementApiPutApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageIdRequest
*/
export interface AlertManagementApiPutApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageIdRequest {
/**
* The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @type {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter}
* @memberof AlertManagementApiPutApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageId
*/
readonly id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter;
/**
* The IID of the Alert
* @type {number}
* @memberof AlertManagementApiPutApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageId
*/
readonly alertIid: number;
/**
* The ID of metric image
* @type {number}
* @memberof AlertManagementApiPutApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageId
*/
readonly metricImageId: number;
/**
* The url to view more metric info
* @type {string}
* @memberof AlertManagementApiPutApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageId
*/
readonly url?: string;
/**
* A description of the image or URL
* @type {string}
* @memberof AlertManagementApiPutApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageId
*/
readonly urlText?: string;
}
/**
* AlertManagementApi - object-oriented interface
* @export
* @class AlertManagementApi
* @extends {BaseAPI}
*/
export declare class AlertManagementApi extends BaseAPI {
/**
* Remove a metric image for an alert
* @param {AlertManagementApiDeleteApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageIdRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof AlertManagementApi
*/
deleteApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageId(requestParameters: AlertManagementApiDeleteApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageIdRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Metric Images for alert
* @param {AlertManagementApiGetApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof AlertManagementApi
*/
getApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImages(requestParameters: AlertManagementApiGetApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Upload a metric image for an alert
* @param {AlertManagementApiPostApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof AlertManagementApi
*/
postApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImages(requestParameters: AlertManagementApiPostApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Workhorse authorize metric image file upload
* @param {AlertManagementApiPostApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesAuthorizeRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof AlertManagementApi
*/
postApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesAuthorize(requestParameters: AlertManagementApiPostApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesAuthorizeRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Update a metric image for an alert
* @param {AlertManagementApiPutApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageIdRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof AlertManagementApi
*/
putApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageId(requestParameters: AlertManagementApiPutApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageIdRequest, options?: RawAxiosRequestConfig): Promise>;
}
/**
* ApplicationApi - axios parameter creator
* @export
*/
export declare const ApplicationApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Get the current appearance
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4ApplicationAppearance: (options?: RawAxiosRequestConfig) => Promise;
/**
* Modify appearance
* @param {string} [title] Instance title on the sign in / sign up page
* @param {string} [description] Markdown text shown on the sign in / sign up page
* @param {string} [pwaName] Name of the Progressive Web App
* @param {string} [pwaShortName] Optional, short name for Progressive Web App
* @param {string} [pwaDescription] An explanation of what the Progressive Web App does
* @param {File} [logo] Instance image used on the sign in / sign up page
* @param {File} [pwaIcon] Icon used for Progressive Web App
* @param {File} [headerLogo] Instance image used for the main navigation bar
* @param {File} [favicon] Instance favicon in .ico/.png format
* @param {string} [newProjectGuidelines] Markdown text shown on the new project page
* @param {string} [profileImageGuidelines] Markdown text shown on the profile page below Public Avatar
* @param {string} [headerMessage] Message within the system header bar
* @param {string} [footerMessage] Message within the system footer bar
* @param {string} [messageBackgroundColor] Background color for the system header / footer bar
* @param {string} [messageFontColor] Font color for the system header / footer bar
* @param {boolean} [emailHeaderAndFooterEnabled] Add header and footer to all outgoing emails if enabled
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
putApiV4ApplicationAppearance: (title?: string, description?: string, pwaName?: string, pwaShortName?: string, pwaDescription?: string, logo?: File, pwaIcon?: File, headerLogo?: File, favicon?: File, newProjectGuidelines?: string, profileImageGuidelines?: string, headerMessage?: string, footerMessage?: string, messageBackgroundColor?: string, messageFontColor?: string, emailHeaderAndFooterEnabled?: boolean, options?: RawAxiosRequestConfig) => Promise;
};
/**
* ApplicationApi - functional programming interface
* @export
*/
export declare const ApplicationApiFp: (configuration?: Configuration) => {
/**
* Get the current appearance
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4ApplicationAppearance(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Modify appearance
* @param {string} [title] Instance title on the sign in / sign up page
* @param {string} [description] Markdown text shown on the sign in / sign up page
* @param {string} [pwaName] Name of the Progressive Web App
* @param {string} [pwaShortName] Optional, short name for Progressive Web App
* @param {string} [pwaDescription] An explanation of what the Progressive Web App does
* @param {File} [logo] Instance image used on the sign in / sign up page
* @param {File} [pwaIcon] Icon used for Progressive Web App
* @param {File} [headerLogo] Instance image used for the main navigation bar
* @param {File} [favicon] Instance favicon in .ico/.png format
* @param {string} [newProjectGuidelines] Markdown text shown on the new project page
* @param {string} [profileImageGuidelines] Markdown text shown on the profile page below Public Avatar
* @param {string} [headerMessage] Message within the system header bar
* @param {string} [footerMessage] Message within the system footer bar
* @param {string} [messageBackgroundColor] Background color for the system header / footer bar
* @param {string} [messageFontColor] Font color for the system header / footer bar
* @param {boolean} [emailHeaderAndFooterEnabled] Add header and footer to all outgoing emails if enabled
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
putApiV4ApplicationAppearance(title?: string, description?: string, pwaName?: string, pwaShortName?: string, pwaDescription?: string, logo?: File, pwaIcon?: File, headerLogo?: File, favicon?: File, newProjectGuidelines?: string, profileImageGuidelines?: string, headerMessage?: string, footerMessage?: string, messageBackgroundColor?: string, messageFontColor?: string, emailHeaderAndFooterEnabled?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* ApplicationApi - factory interface
* @export
*/
export declare const ApplicationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Get the current appearance
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4ApplicationAppearance(options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Modify appearance
* @param {ApplicationApiPutApiV4ApplicationAppearanceRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
putApiV4ApplicationAppearance(requestParameters?: ApplicationApiPutApiV4ApplicationAppearanceRequest, options?: RawAxiosRequestConfig): AxiosPromise;
};
/**
* Request parameters for putApiV4ApplicationAppearance operation in ApplicationApi.
* @export
* @interface ApplicationApiPutApiV4ApplicationAppearanceRequest
*/
export interface ApplicationApiPutApiV4ApplicationAppearanceRequest {
/**
* Instance title on the sign in / sign up page
* @type {string}
* @memberof ApplicationApiPutApiV4ApplicationAppearance
*/
readonly title?: string;
/**
* Markdown text shown on the sign in / sign up page
* @type {string}
* @memberof ApplicationApiPutApiV4ApplicationAppearance
*/
readonly description?: string;
/**
* Name of the Progressive Web App
* @type {string}
* @memberof ApplicationApiPutApiV4ApplicationAppearance
*/
readonly pwaName?: string;
/**
* Optional, short name for Progressive Web App
* @type {string}
* @memberof ApplicationApiPutApiV4ApplicationAppearance
*/
readonly pwaShortName?: string;
/**
* An explanation of what the Progressive Web App does
* @type {string}
* @memberof ApplicationApiPutApiV4ApplicationAppearance
*/
readonly pwaDescription?: string;
/**
* Instance image used on the sign in / sign up page
* @type {File}
* @memberof ApplicationApiPutApiV4ApplicationAppearance
*/
readonly logo?: File;
/**
* Icon used for Progressive Web App
* @type {File}
* @memberof ApplicationApiPutApiV4ApplicationAppearance
*/
readonly pwaIcon?: File;
/**
* Instance image used for the main navigation bar
* @type {File}
* @memberof ApplicationApiPutApiV4ApplicationAppearance
*/
readonly headerLogo?: File;
/**
* Instance favicon in .ico/.png format
* @type {File}
* @memberof ApplicationApiPutApiV4ApplicationAppearance
*/
readonly favicon?: File;
/**
* Markdown text shown on the new project page
* @type {string}
* @memberof ApplicationApiPutApiV4ApplicationAppearance
*/
readonly newProjectGuidelines?: string;
/**
* Markdown text shown on the profile page below Public Avatar
* @type {string}
* @memberof ApplicationApiPutApiV4ApplicationAppearance
*/
readonly profileImageGuidelines?: string;
/**
* Message within the system header bar
* @type {string}
* @memberof ApplicationApiPutApiV4ApplicationAppearance
*/
readonly headerMessage?: string;
/**
* Message within the system footer bar
* @type {string}
* @memberof ApplicationApiPutApiV4ApplicationAppearance
*/
readonly footerMessage?: string;
/**
* Background color for the system header / footer bar
* @type {string}
* @memberof ApplicationApiPutApiV4ApplicationAppearance
*/
readonly messageBackgroundColor?: string;
/**
* Font color for the system header / footer bar
* @type {string}
* @memberof ApplicationApiPutApiV4ApplicationAppearance
*/
readonly messageFontColor?: string;
/**
* Add header and footer to all outgoing emails if enabled
* @type {boolean}
* @memberof ApplicationApiPutApiV4ApplicationAppearance
*/
readonly emailHeaderAndFooterEnabled?: boolean;
}
/**
* ApplicationApi - object-oriented interface
* @export
* @class ApplicationApi
* @extends {BaseAPI}
*/
export declare class ApplicationApi extends BaseAPI {
/**
* Get the current appearance
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ApplicationApi
*/
getApiV4ApplicationAppearance(options?: RawAxiosRequestConfig): Promise>;
/**
* Modify appearance
* @param {ApplicationApiPutApiV4ApplicationAppearanceRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ApplicationApi
*/
putApiV4ApplicationAppearance(requestParameters?: ApplicationApiPutApiV4ApplicationAppearanceRequest, options?: RawAxiosRequestConfig): Promise>;
}
/**
* ApplicationsApi - axios parameter creator
* @export
*/
export declare const ApplicationsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Delete a specific application
* @summary Delete an application
* @param {number} id The ID of the application (not the application_id)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteApiV4ApplicationsId: (id: number, options?: RawAxiosRequestConfig) => Promise;
/**
* List all registered applications
* @summary Get applications
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4Applications: (options?: RawAxiosRequestConfig) => Promise;
/**
* This feature was introduced in GitLab 10.5
* @summary Create a new application
* @param {PostApiV4ApplicationsRequest} postApiV4ApplicationsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postApiV4Applications: (postApiV4ApplicationsRequest: PostApiV4ApplicationsRequest, options?: RawAxiosRequestConfig) => Promise;
};
/**
* ApplicationsApi - functional programming interface
* @export
*/
export declare const ApplicationsApiFp: (configuration?: Configuration) => {
/**
* Delete a specific application
* @summary Delete an application
* @param {number} id The ID of the application (not the application_id)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteApiV4ApplicationsId(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* List all registered applications
* @summary Get applications
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4Applications(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>;
/**
* This feature was introduced in GitLab 10.5
* @summary Create a new application
* @param {PostApiV4ApplicationsRequest} postApiV4ApplicationsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postApiV4Applications(postApiV4ApplicationsRequest: PostApiV4ApplicationsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* ApplicationsApi - factory interface
* @export
*/
export declare const ApplicationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Delete a specific application
* @summary Delete an application
* @param {ApplicationsApiDeleteApiV4ApplicationsIdRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteApiV4ApplicationsId(requestParameters: ApplicationsApiDeleteApiV4ApplicationsIdRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* List all registered applications
* @summary Get applications
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4Applications(options?: RawAxiosRequestConfig): AxiosPromise>;
/**
* This feature was introduced in GitLab 10.5
* @summary Create a new application
* @param {ApplicationsApiPostApiV4ApplicationsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postApiV4Applications(requestParameters: ApplicationsApiPostApiV4ApplicationsRequest, options?: RawAxiosRequestConfig): AxiosPromise;
};
/**
* Request parameters for deleteApiV4ApplicationsId operation in ApplicationsApi.
* @export
* @interface ApplicationsApiDeleteApiV4ApplicationsIdRequest
*/
export interface ApplicationsApiDeleteApiV4ApplicationsIdRequest {
/**
* The ID of the application (not the application_id)
* @type {number}
* @memberof ApplicationsApiDeleteApiV4ApplicationsId
*/
readonly id: number;
}
/**
* Request parameters for postApiV4Applications operation in ApplicationsApi.
* @export
* @interface ApplicationsApiPostApiV4ApplicationsRequest
*/
export interface ApplicationsApiPostApiV4ApplicationsRequest {
/**
*
* @type {PostApiV4ApplicationsRequest}
* @memberof ApplicationsApiPostApiV4Applications
*/
readonly postApiV4ApplicationsRequest: PostApiV4ApplicationsRequest;
}
/**
* ApplicationsApi - object-oriented interface
* @export
* @class ApplicationsApi
* @extends {BaseAPI}
*/
export declare class ApplicationsApi extends BaseAPI {
/**
* Delete a specific application
* @summary Delete an application
* @param {ApplicationsApiDeleteApiV4ApplicationsIdRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ApplicationsApi
*/
deleteApiV4ApplicationsId(requestParameters: ApplicationsApiDeleteApiV4ApplicationsIdRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* List all registered applications
* @summary Get applications
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ApplicationsApi
*/
getApiV4Applications(options?: RawAxiosRequestConfig): Promise>;
/**
* This feature was introduced in GitLab 10.5
* @summary Create a new application
* @param {ApplicationsApiPostApiV4ApplicationsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ApplicationsApi
*/
postApiV4Applications(requestParameters: ApplicationsApiPostApiV4ApplicationsRequest, options?: RawAxiosRequestConfig): Promise>;
}
/**
* AvatarApi - axios parameter creator
* @export
*/
export declare const AvatarApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Return avatar url for a user
* @param {string} email Public email address of the user
* @param {number} [size] Single pixel dimension for Gravatar images
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4Avatar: (email: string, size?: number, options?: RawAxiosRequestConfig) => Promise;
};
/**
* AvatarApi - functional programming interface
* @export
*/
export declare const AvatarApiFp: (configuration?: Configuration) => {
/**
* Return avatar url for a user
* @param {string} email Public email address of the user
* @param {number} [size] Single pixel dimension for Gravatar images
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4Avatar(email: string, size?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* AvatarApi - factory interface
* @export
*/
export declare const AvatarApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Return avatar url for a user
* @param {AvatarApiGetApiV4AvatarRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4Avatar(requestParameters: AvatarApiGetApiV4AvatarRequest, options?: RawAxiosRequestConfig): AxiosPromise;
};
/**
* Request parameters for getApiV4Avatar operation in AvatarApi.
* @export
* @interface AvatarApiGetApiV4AvatarRequest
*/
export interface AvatarApiGetApiV4AvatarRequest {
/**
* Public email address of the user
* @type {string}
* @memberof AvatarApiGetApiV4Avatar
*/
readonly email: string;
/**
* Single pixel dimension for Gravatar images
* @type {number}
* @memberof AvatarApiGetApiV4Avatar
*/
readonly size?: number;
}
/**
* AvatarApi - object-oriented interface
* @export
* @class AvatarApi
* @extends {BaseAPI}
*/
export declare class AvatarApi extends BaseAPI {
/**
* Return avatar url for a user
* @param {AvatarApiGetApiV4AvatarRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof AvatarApi
*/
getApiV4Avatar(requestParameters: AvatarApiGetApiV4AvatarRequest, options?: RawAxiosRequestConfig): Promise>;
}
/**
* BadgesApi - axios parameter creator
* @export
*/
export declare const BadgesApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* This feature was introduced in GitLab 10.6.
* @summary Removes a badge from the group.
* @param {string} id The ID or URL-encoded path of the group owned by the authenticated user.
* @param {number} badgeId The badge ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteApiV4GroupsIdBadgesBadgeId: (id: string, badgeId: number, options?: RawAxiosRequestConfig) => Promise;
/**
* This feature was introduced in GitLab 10.6.
* @summary Removes a badge from the project.
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {number} badgeId The badge ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteApiV4ProjectsIdBadgesBadgeId: (id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, badgeId: number, options?: RawAxiosRequestConfig) => Promise;
/**
* This feature was introduced in GitLab 10.6.
* @summary Gets a list of group badges viewable by the authenticated user.
* @param {string} id The ID or URL-encoded path of the group owned by the authenticated user.
* @param {number} [page] Current page number
* @param {number} [perPage] Number of items per page
* @param {string} [name] Name for the badge
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4GroupsIdBadges: (id: string, page?: number, perPage?: number, name?: string, options?: RawAxiosRequestConfig) => Promise;
/**
* This feature was introduced in GitLab 10.6.
* @summary Gets a badge of a group.
* @param {string} id The ID or URL-encoded path of the group owned by the authenticated user.
* @param {number} badgeId The badge ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4GroupsIdBadgesBadgeId: (id: string, badgeId: number, options?: RawAxiosRequestConfig) => Promise;
/**
* This feature was introduced in GitLab 10.6.
* @summary Preview a badge from a group.
* @param {string} id The ID or URL-encoded path of the group owned by the authenticated user.
* @param {string} linkUrl URL of the badge link
* @param {string} imageUrl URL of the badge image
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4GroupsIdBadgesRender: (id: string, linkUrl: string, imageUrl: string, options?: RawAxiosRequestConfig) => Promise;
/**
* This feature was introduced in GitLab 10.6.
* @summary Gets a list of project badges viewable by the authenticated user.
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {number} [page] Current page number
* @param {number} [perPage] Number of items per page
* @param {string} [name] Name for the badge
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4ProjectsIdBadges: (id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, page?: number, perPage?: number, name?: string, options?: RawAxiosRequestConfig) => Promise;
/**
* This feature was introduced in GitLab 10.6.
* @summary Gets a badge of a project.
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {number} badgeId The badge ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4ProjectsIdBadgesBadgeId: (id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, badgeId: number, options?: RawAxiosRequestConfig) => Promise;
/**
* This feature was introduced in GitLab 10.6.
* @summary Preview a badge from a project.
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {string} linkUrl URL of the badge link
* @param {string} imageUrl URL of the badge image
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4ProjectsIdBadgesRender: (id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, linkUrl: string, imageUrl: string, options?: RawAxiosRequestConfig) => Promise;
/**
* This feature was introduced in GitLab 10.6.
* @summary Adds a badge to a group.
* @param {string} id The ID or URL-encoded path of the group owned by the authenticated user.
* @param {PostApiV4GroupsIdBadgesRequest} postApiV4GroupsIdBadgesRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postApiV4GroupsIdBadges: (id: string, postApiV4GroupsIdBadgesRequest: PostApiV4GroupsIdBadgesRequest, options?: RawAxiosRequestConfig) => Promise;
/**
* This feature was introduced in GitLab 10.6.
* @summary Adds a badge to a project.
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {PostApiV4GroupsIdBadgesRequest} postApiV4GroupsIdBadgesRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postApiV4ProjectsIdBadges: (id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, postApiV4GroupsIdBadgesRequest: PostApiV4GroupsIdBadgesRequest, options?: RawAxiosRequestConfig) => Promise;
/**
* This feature was introduced in GitLab 10.6.
* @summary Updates a badge of a group.
* @param {string} id The ID or URL-encoded path of the group owned by the authenticated user.
* @param {number} badgeId
* @param {PutApiV4GroupsIdBadgesBadgeIdRequest} [putApiV4GroupsIdBadgesBadgeIdRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
putApiV4GroupsIdBadgesBadgeId: (id: string, badgeId: number, putApiV4GroupsIdBadgesBadgeIdRequest?: PutApiV4GroupsIdBadgesBadgeIdRequest, options?: RawAxiosRequestConfig) => Promise;
/**
* This feature was introduced in GitLab 10.6.
* @summary Updates a badge of a project.
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {number} badgeId
* @param {PutApiV4GroupsIdBadgesBadgeIdRequest} [putApiV4GroupsIdBadgesBadgeIdRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
putApiV4ProjectsIdBadgesBadgeId: (id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, badgeId: number, putApiV4GroupsIdBadgesBadgeIdRequest?: PutApiV4GroupsIdBadgesBadgeIdRequest, options?: RawAxiosRequestConfig) => Promise;
};
/**
* BadgesApi - functional programming interface
* @export
*/
export declare const BadgesApiFp: (configuration?: Configuration) => {
/**
* This feature was introduced in GitLab 10.6.
* @summary Removes a badge from the group.
* @param {string} id The ID or URL-encoded path of the group owned by the authenticated user.
* @param {number} badgeId The badge ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteApiV4GroupsIdBadgesBadgeId(id: string, badgeId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* This feature was introduced in GitLab 10.6.
* @summary Removes a badge from the project.
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {number} badgeId The badge ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteApiV4ProjectsIdBadgesBadgeId(id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, badgeId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* This feature was introduced in GitLab 10.6.
* @summary Gets a list of group badges viewable by the authenticated user.
* @param {string} id The ID or URL-encoded path of the group owned by the authenticated user.
* @param {number} [page] Current page number
* @param {number} [perPage] Number of items per page
* @param {string} [name] Name for the badge
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4GroupsIdBadges(id: string, page?: number, perPage?: number, name?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>;
/**
* This feature was introduced in GitLab 10.6.
* @summary Gets a badge of a group.
* @param {string} id The ID or URL-encoded path of the group owned by the authenticated user.
* @param {number} badgeId The badge ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4GroupsIdBadgesBadgeId(id: string, badgeId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* This feature was introduced in GitLab 10.6.
* @summary Preview a badge from a group.
* @param {string} id The ID or URL-encoded path of the group owned by the authenticated user.
* @param {string} linkUrl URL of the badge link
* @param {string} imageUrl URL of the badge image
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4GroupsIdBadgesRender(id: string, linkUrl: string, imageUrl: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* This feature was introduced in GitLab 10.6.
* @summary Gets a list of project badges viewable by the authenticated user.
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {number} [page] Current page number
* @param {number} [perPage] Number of items per page
* @param {string} [name] Name for the badge
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4ProjectsIdBadges(id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, page?: number, perPage?: number, name?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>;
/**
* This feature was introduced in GitLab 10.6.
* @summary Gets a badge of a project.
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {number} badgeId The badge ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4ProjectsIdBadgesBadgeId(id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, badgeId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* This feature was introduced in GitLab 10.6.
* @summary Preview a badge from a project.
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {string} linkUrl URL of the badge link
* @param {string} imageUrl URL of the badge image
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4ProjectsIdBadgesRender(id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, linkUrl: string, imageUrl: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* This feature was introduced in GitLab 10.6.
* @summary Adds a badge to a group.
* @param {string} id The ID or URL-encoded path of the group owned by the authenticated user.
* @param {PostApiV4GroupsIdBadgesRequest} postApiV4GroupsIdBadgesRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postApiV4GroupsIdBadges(id: string, postApiV4GroupsIdBadgesRequest: PostApiV4GroupsIdBadgesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* This feature was introduced in GitLab 10.6.
* @summary Adds a badge to a project.
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {PostApiV4GroupsIdBadgesRequest} postApiV4GroupsIdBadgesRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postApiV4ProjectsIdBadges(id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, postApiV4GroupsIdBadgesRequest: PostApiV4GroupsIdBadgesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* This feature was introduced in GitLab 10.6.
* @summary Updates a badge of a group.
* @param {string} id The ID or URL-encoded path of the group owned by the authenticated user.
* @param {number} badgeId
* @param {PutApiV4GroupsIdBadgesBadgeIdRequest} [putApiV4GroupsIdBadgesBadgeIdRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
putApiV4GroupsIdBadgesBadgeId(id: string, badgeId: number, putApiV4GroupsIdBadgesBadgeIdRequest?: PutApiV4GroupsIdBadgesBadgeIdRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* This feature was introduced in GitLab 10.6.
* @summary Updates a badge of a project.
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {number} badgeId
* @param {PutApiV4GroupsIdBadgesBadgeIdRequest} [putApiV4GroupsIdBadgesBadgeIdRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
putApiV4ProjectsIdBadgesBadgeId(id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, badgeId: number, putApiV4GroupsIdBadgesBadgeIdRequest?: PutApiV4GroupsIdBadgesBadgeIdRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* BadgesApi - factory interface
* @export
*/
export declare const BadgesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* This feature was introduced in GitLab 10.6.
* @summary Removes a badge from the group.
* @param {BadgesApiDeleteApiV4GroupsIdBadgesBadgeIdRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteApiV4GroupsIdBadgesBadgeId(requestParameters: BadgesApiDeleteApiV4GroupsIdBadgesBadgeIdRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* This feature was introduced in GitLab 10.6.
* @summary Removes a badge from the project.
* @param {BadgesApiDeleteApiV4ProjectsIdBadgesBadgeIdRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteApiV4ProjectsIdBadgesBadgeId(requestParameters: BadgesApiDeleteApiV4ProjectsIdBadgesBadgeIdRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* This feature was introduced in GitLab 10.6.
* @summary Gets a list of group badges viewable by the authenticated user.
* @param {BadgesApiGetApiV4GroupsIdBadgesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4GroupsIdBadges(requestParameters: BadgesApiGetApiV4GroupsIdBadgesRequest, options?: RawAxiosRequestConfig): AxiosPromise>;
/**
* This feature was introduced in GitLab 10.6.
* @summary Gets a badge of a group.
* @param {BadgesApiGetApiV4GroupsIdBadgesBadgeIdRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4GroupsIdBadgesBadgeId(requestParameters: BadgesApiGetApiV4GroupsIdBadgesBadgeIdRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* This feature was introduced in GitLab 10.6.
* @summary Preview a badge from a group.
* @param {BadgesApiGetApiV4GroupsIdBadgesRenderRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4GroupsIdBadgesRender(requestParameters: BadgesApiGetApiV4GroupsIdBadgesRenderRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* This feature was introduced in GitLab 10.6.
* @summary Gets a list of project badges viewable by the authenticated user.
* @param {BadgesApiGetApiV4ProjectsIdBadgesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4ProjectsIdBadges(requestParameters: BadgesApiGetApiV4ProjectsIdBadgesRequest, options?: RawAxiosRequestConfig): AxiosPromise>;
/**
* This feature was introduced in GitLab 10.6.
* @summary Gets a badge of a project.
* @param {BadgesApiGetApiV4ProjectsIdBadgesBadgeIdRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4ProjectsIdBadgesBadgeId(requestParameters: BadgesApiGetApiV4ProjectsIdBadgesBadgeIdRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* This feature was introduced in GitLab 10.6.
* @summary Preview a badge from a project.
* @param {BadgesApiGetApiV4ProjectsIdBadgesRenderRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4ProjectsIdBadgesRender(requestParameters: BadgesApiGetApiV4ProjectsIdBadgesRenderRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* This feature was introduced in GitLab 10.6.
* @summary Adds a badge to a group.
* @param {BadgesApiPostApiV4GroupsIdBadgesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postApiV4GroupsIdBadges(requestParameters: BadgesApiPostApiV4GroupsIdBadgesRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* This feature was introduced in GitLab 10.6.
* @summary Adds a badge to a project.
* @param {BadgesApiPostApiV4ProjectsIdBadgesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postApiV4ProjectsIdBadges(requestParameters: BadgesApiPostApiV4ProjectsIdBadgesRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* This feature was introduced in GitLab 10.6.
* @summary Updates a badge of a group.
* @param {BadgesApiPutApiV4GroupsIdBadgesBadgeIdRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
putApiV4GroupsIdBadgesBadgeId(requestParameters: BadgesApiPutApiV4GroupsIdBadgesBadgeIdRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* This feature was introduced in GitLab 10.6.
* @summary Updates a badge of a project.
* @param {BadgesApiPutApiV4ProjectsIdBadgesBadgeIdRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
putApiV4ProjectsIdBadgesBadgeId(requestParameters: BadgesApiPutApiV4ProjectsIdBadgesBadgeIdRequest, options?: RawAxiosRequestConfig): AxiosPromise;
};
/**
* Request parameters for deleteApiV4GroupsIdBadgesBadgeId operation in BadgesApi.
* @export
* @interface BadgesApiDeleteApiV4GroupsIdBadgesBadgeIdRequest
*/
export interface BadgesApiDeleteApiV4GroupsIdBadgesBadgeIdRequest {
/**
* The ID or URL-encoded path of the group owned by the authenticated user.
* @type {string}
* @memberof BadgesApiDeleteApiV4GroupsIdBadgesBadgeId
*/
readonly id: string;
/**
* The badge ID
* @type {number}
* @memberof BadgesApiDeleteApiV4GroupsIdBadgesBadgeId
*/
readonly badgeId: number;
}
/**
* Request parameters for deleteApiV4ProjectsIdBadgesBadgeId operation in BadgesApi.
* @export
* @interface BadgesApiDeleteApiV4ProjectsIdBadgesBadgeIdRequest
*/
export interface BadgesApiDeleteApiV4ProjectsIdBadgesBadgeIdRequest {
/**
* The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @type {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter}
* @memberof BadgesApiDeleteApiV4ProjectsIdBadgesBadgeId
*/
readonly id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter;
/**
* The badge ID
* @type {number}
* @memberof BadgesApiDeleteApiV4ProjectsIdBadgesBadgeId
*/
readonly badgeId: number;
}
/**
* Request parameters for getApiV4GroupsIdBadges operation in BadgesApi.
* @export
* @interface BadgesApiGetApiV4GroupsIdBadgesRequest
*/
export interface BadgesApiGetApiV4GroupsIdBadgesRequest {
/**
* The ID or URL-encoded path of the group owned by the authenticated user.
* @type {string}
* @memberof BadgesApiGetApiV4GroupsIdBadges
*/
readonly id: string;
/**
* Current page number
* @type {number}
* @memberof BadgesApiGetApiV4GroupsIdBadges
*/
readonly page?: number;
/**
* Number of items per page
* @type {number}
* @memberof BadgesApiGetApiV4GroupsIdBadges
*/
readonly perPage?: number;
/**
* Name for the badge
* @type {string}
* @memberof BadgesApiGetApiV4GroupsIdBadges
*/
readonly name?: string;
}
/**
* Request parameters for getApiV4GroupsIdBadgesBadgeId operation in BadgesApi.
* @export
* @interface BadgesApiGetApiV4GroupsIdBadgesBadgeIdRequest
*/
export interface BadgesApiGetApiV4GroupsIdBadgesBadgeIdRequest {
/**
* The ID or URL-encoded path of the group owned by the authenticated user.
* @type {string}
* @memberof BadgesApiGetApiV4GroupsIdBadgesBadgeId
*/
readonly id: string;
/**
* The badge ID
* @type {number}
* @memberof BadgesApiGetApiV4GroupsIdBadgesBadgeId
*/
readonly badgeId: number;
}
/**
* Request parameters for getApiV4GroupsIdBadgesRender operation in BadgesApi.
* @export
* @interface BadgesApiGetApiV4GroupsIdBadgesRenderRequest
*/
export interface BadgesApiGetApiV4GroupsIdBadgesRenderRequest {
/**
* The ID or URL-encoded path of the group owned by the authenticated user.
* @type {string}
* @memberof BadgesApiGetApiV4GroupsIdBadgesRender
*/
readonly id: string;
/**
* URL of the badge link
* @type {string}
* @memberof BadgesApiGetApiV4GroupsIdBadgesRender
*/
readonly linkUrl: string;
/**
* URL of the badge image
* @type {string}
* @memberof BadgesApiGetApiV4GroupsIdBadgesRender
*/
readonly imageUrl: string;
}
/**
* Request parameters for getApiV4ProjectsIdBadges operation in BadgesApi.
* @export
* @interface BadgesApiGetApiV4ProjectsIdBadgesRequest
*/
export interface BadgesApiGetApiV4ProjectsIdBadgesRequest {
/**
* The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @type {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter}
* @memberof BadgesApiGetApiV4ProjectsIdBadges
*/
readonly id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter;
/**
* Current page number
* @type {number}
* @memberof BadgesApiGetApiV4ProjectsIdBadges
*/
readonly page?: number;
/**
* Number of items per page
* @type {number}
* @memberof BadgesApiGetApiV4ProjectsIdBadges
*/
readonly perPage?: number;
/**
* Name for the badge
* @type {string}
* @memberof BadgesApiGetApiV4ProjectsIdBadges
*/
readonly name?: string;
}
/**
* Request parameters for getApiV4ProjectsIdBadgesBadgeId operation in BadgesApi.
* @export
* @interface BadgesApiGetApiV4ProjectsIdBadgesBadgeIdRequest
*/
export interface BadgesApiGetApiV4ProjectsIdBadgesBadgeIdRequest {
/**
* The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @type {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter}
* @memberof BadgesApiGetApiV4ProjectsIdBadgesBadgeId
*/
readonly id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter;
/**
* The badge ID
* @type {number}
* @memberof BadgesApiGetApiV4ProjectsIdBadgesBadgeId
*/
readonly badgeId: number;
}
/**
* Request parameters for getApiV4ProjectsIdBadgesRender operation in BadgesApi.
* @export
* @interface BadgesApiGetApiV4ProjectsIdBadgesRenderRequest
*/
export interface BadgesApiGetApiV4ProjectsIdBadgesRenderRequest {
/**
* The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @type {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter}
* @memberof BadgesApiGetApiV4ProjectsIdBadgesRender
*/
readonly id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter;
/**
* URL of the badge link
* @type {string}
* @memberof BadgesApiGetApiV4ProjectsIdBadgesRender
*/
readonly linkUrl: string;
/**
* URL of the badge image
* @type {string}
* @memberof BadgesApiGetApiV4ProjectsIdBadgesRender
*/
readonly imageUrl: string;
}
/**
* Request parameters for postApiV4GroupsIdBadges operation in BadgesApi.
* @export
* @interface BadgesApiPostApiV4GroupsIdBadgesRequest
*/
export interface BadgesApiPostApiV4GroupsIdBadgesRequest {
/**
* The ID or URL-encoded path of the group owned by the authenticated user.
* @type {string}
* @memberof BadgesApiPostApiV4GroupsIdBadges
*/
readonly id: string;
/**
*
* @type {PostApiV4GroupsIdBadgesRequest}
* @memberof BadgesApiPostApiV4GroupsIdBadges
*/
readonly postApiV4GroupsIdBadgesRequest: PostApiV4GroupsIdBadgesRequest;
}
/**
* Request parameters for postApiV4ProjectsIdBadges operation in BadgesApi.
* @export
* @interface BadgesApiPostApiV4ProjectsIdBadgesRequest
*/
export interface BadgesApiPostApiV4ProjectsIdBadgesRequest {
/**
* The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @type {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter}
* @memberof BadgesApiPostApiV4ProjectsIdBadges
*/
readonly id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter;
/**
*
* @type {PostApiV4GroupsIdBadgesRequest}
* @memberof BadgesApiPostApiV4ProjectsIdBadges
*/
readonly postApiV4GroupsIdBadgesRequest: PostApiV4GroupsIdBadgesRequest;
}
/**
* Request parameters for putApiV4GroupsIdBadgesBadgeId operation in BadgesApi.
* @export
* @interface BadgesApiPutApiV4GroupsIdBadgesBadgeIdRequest
*/
export interface BadgesApiPutApiV4GroupsIdBadgesBadgeIdRequest {
/**
* The ID or URL-encoded path of the group owned by the authenticated user.
* @type {string}
* @memberof BadgesApiPutApiV4GroupsIdBadgesBadgeId
*/
readonly id: string;
/**
*
* @type {number}
* @memberof BadgesApiPutApiV4GroupsIdBadgesBadgeId
*/
readonly badgeId: number;
/**
*
* @type {PutApiV4GroupsIdBadgesBadgeIdRequest}
* @memberof BadgesApiPutApiV4GroupsIdBadgesBadgeId
*/
readonly putApiV4GroupsIdBadgesBadgeIdRequest?: PutApiV4GroupsIdBadgesBadgeIdRequest;
}
/**
* Request parameters for putApiV4ProjectsIdBadgesBadgeId operation in BadgesApi.
* @export
* @interface BadgesApiPutApiV4ProjectsIdBadgesBadgeIdRequest
*/
export interface BadgesApiPutApiV4ProjectsIdBadgesBadgeIdRequest {
/**
* The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @type {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter}
* @memberof BadgesApiPutApiV4ProjectsIdBadgesBadgeId
*/
readonly id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter;
/**
*
* @type {number}
* @memberof BadgesApiPutApiV4ProjectsIdBadgesBadgeId
*/
readonly badgeId: number;
/**
*
* @type {PutApiV4GroupsIdBadgesBadgeIdRequest}
* @memberof BadgesApiPutApiV4ProjectsIdBadgesBadgeId
*/
readonly putApiV4GroupsIdBadgesBadgeIdRequest?: PutApiV4GroupsIdBadgesBadgeIdRequest;
}
/**
* BadgesApi - object-oriented interface
* @export
* @class BadgesApi
* @extends {BaseAPI}
*/
export declare class BadgesApi extends BaseAPI {
/**
* This feature was introduced in GitLab 10.6.
* @summary Removes a badge from the group.
* @param {BadgesApiDeleteApiV4GroupsIdBadgesBadgeIdRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BadgesApi
*/
deleteApiV4GroupsIdBadgesBadgeId(requestParameters: BadgesApiDeleteApiV4GroupsIdBadgesBadgeIdRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* This feature was introduced in GitLab 10.6.
* @summary Removes a badge from the project.
* @param {BadgesApiDeleteApiV4ProjectsIdBadgesBadgeIdRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BadgesApi
*/
deleteApiV4ProjectsIdBadgesBadgeId(requestParameters: BadgesApiDeleteApiV4ProjectsIdBadgesBadgeIdRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* This feature was introduced in GitLab 10.6.
* @summary Gets a list of group badges viewable by the authenticated user.
* @param {BadgesApiGetApiV4GroupsIdBadgesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BadgesApi
*/
getApiV4GroupsIdBadges(requestParameters: BadgesApiGetApiV4GroupsIdBadgesRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* This feature was introduced in GitLab 10.6.
* @summary Gets a badge of a group.
* @param {BadgesApiGetApiV4GroupsIdBadgesBadgeIdRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BadgesApi
*/
getApiV4GroupsIdBadgesBadgeId(requestParameters: BadgesApiGetApiV4GroupsIdBadgesBadgeIdRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* This feature was introduced in GitLab 10.6.
* @summary Preview a badge from a group.
* @param {BadgesApiGetApiV4GroupsIdBadgesRenderRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BadgesApi
*/
getApiV4GroupsIdBadgesRender(requestParameters: BadgesApiGetApiV4GroupsIdBadgesRenderRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* This feature was introduced in GitLab 10.6.
* @summary Gets a list of project badges viewable by the authenticated user.
* @param {BadgesApiGetApiV4ProjectsIdBadgesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BadgesApi
*/
getApiV4ProjectsIdBadges(requestParameters: BadgesApiGetApiV4ProjectsIdBadgesRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* This feature was introduced in GitLab 10.6.
* @summary Gets a badge of a project.
* @param {BadgesApiGetApiV4ProjectsIdBadgesBadgeIdRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BadgesApi
*/
getApiV4ProjectsIdBadgesBadgeId(requestParameters: BadgesApiGetApiV4ProjectsIdBadgesBadgeIdRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* This feature was introduced in GitLab 10.6.
* @summary Preview a badge from a project.
* @param {BadgesApiGetApiV4ProjectsIdBadgesRenderRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BadgesApi
*/
getApiV4ProjectsIdBadgesRender(requestParameters: BadgesApiGetApiV4ProjectsIdBadgesRenderRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* This feature was introduced in GitLab 10.6.
* @summary Adds a badge to a group.
* @param {BadgesApiPostApiV4GroupsIdBadgesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BadgesApi
*/
postApiV4GroupsIdBadges(requestParameters: BadgesApiPostApiV4GroupsIdBadgesRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* This feature was introduced in GitLab 10.6.
* @summary Adds a badge to a project.
* @param {BadgesApiPostApiV4ProjectsIdBadgesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BadgesApi
*/
postApiV4ProjectsIdBadges(requestParameters: BadgesApiPostApiV4ProjectsIdBadgesRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* This feature was introduced in GitLab 10.6.
* @summary Updates a badge of a group.
* @param {BadgesApiPutApiV4GroupsIdBadgesBadgeIdRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BadgesApi
*/
putApiV4GroupsIdBadgesBadgeId(requestParameters: BadgesApiPutApiV4GroupsIdBadgesBadgeIdRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* This feature was introduced in GitLab 10.6.
* @summary Updates a badge of a project.
* @param {BadgesApiPutApiV4ProjectsIdBadgesBadgeIdRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BadgesApi
*/
putApiV4ProjectsIdBadgesBadgeId(requestParameters: BadgesApiPutApiV4ProjectsIdBadgesBadgeIdRequest, options?: RawAxiosRequestConfig): Promise>;
}
/**
* BatchedBackgroundMigrationsApi - axios parameter creator
* @export
*/
export declare const BatchedBackgroundMigrationsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Get the list of batched background migrations
* @param {GetApiV4AdminBatchedBackgroundMigrationsDatabaseEnum} [database] The name of the database, the default `main`
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4AdminBatchedBackgroundMigrations: (database?: GetApiV4AdminBatchedBackgroundMigrationsDatabaseEnum, options?: RawAxiosRequestConfig) => Promise;
/**
* Retrieve a batched background migration
* @param {number} id The batched background migration id
* @param {GetApiV4AdminBatchedBackgroundMigrationsIdDatabaseEnum} [database] The name of the database
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4AdminBatchedBackgroundMigrationsId: (id: number, database?: GetApiV4AdminBatchedBackgroundMigrationsIdDatabaseEnum, options?: RawAxiosRequestConfig) => Promise;
/**
* Pause a batched background migration
* @param {number} id The batched background migration id
* @param {PutApiV4AdminBatchedBackgroundMigrationsIdResumeRequest} [putApiV4AdminBatchedBackgroundMigrationsIdResumeRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
putApiV4AdminBatchedBackgroundMigrationsIdPause: (id: number, putApiV4AdminBatchedBackgroundMigrationsIdResumeRequest?: PutApiV4AdminBatchedBackgroundMigrationsIdResumeRequest, options?: RawAxiosRequestConfig) => Promise;
/**
* Resume a batched background migration
* @param {number} id The batched background migration id
* @param {PutApiV4AdminBatchedBackgroundMigrationsIdResumeRequest} [putApiV4AdminBatchedBackgroundMigrationsIdResumeRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
putApiV4AdminBatchedBackgroundMigrationsIdResume: (id: number, putApiV4AdminBatchedBackgroundMigrationsIdResumeRequest?: PutApiV4AdminBatchedBackgroundMigrationsIdResumeRequest, options?: RawAxiosRequestConfig) => Promise;
};
/**
* BatchedBackgroundMigrationsApi - functional programming interface
* @export
*/
export declare const BatchedBackgroundMigrationsApiFp: (configuration?: Configuration) => {
/**
* Get the list of batched background migrations
* @param {GetApiV4AdminBatchedBackgroundMigrationsDatabaseEnum} [database] The name of the database, the default `main`
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4AdminBatchedBackgroundMigrations(database?: GetApiV4AdminBatchedBackgroundMigrationsDatabaseEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>;
/**
* Retrieve a batched background migration
* @param {number} id The batched background migration id
* @param {GetApiV4AdminBatchedBackgroundMigrationsIdDatabaseEnum} [database] The name of the database
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4AdminBatchedBackgroundMigrationsId(id: number, database?: GetApiV4AdminBatchedBackgroundMigrationsIdDatabaseEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Pause a batched background migration
* @param {number} id The batched background migration id
* @param {PutApiV4AdminBatchedBackgroundMigrationsIdResumeRequest} [putApiV4AdminBatchedBackgroundMigrationsIdResumeRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
putApiV4AdminBatchedBackgroundMigrationsIdPause(id: number, putApiV4AdminBatchedBackgroundMigrationsIdResumeRequest?: PutApiV4AdminBatchedBackgroundMigrationsIdResumeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Resume a batched background migration
* @param {number} id The batched background migration id
* @param {PutApiV4AdminBatchedBackgroundMigrationsIdResumeRequest} [putApiV4AdminBatchedBackgroundMigrationsIdResumeRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
putApiV4AdminBatchedBackgroundMigrationsIdResume(id: number, putApiV4AdminBatchedBackgroundMigrationsIdResumeRequest?: PutApiV4AdminBatchedBackgroundMigrationsIdResumeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* BatchedBackgroundMigrationsApi - factory interface
* @export
*/
export declare const BatchedBackgroundMigrationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Get the list of batched background migrations
* @param {BatchedBackgroundMigrationsApiGetApiV4AdminBatchedBackgroundMigrationsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4AdminBatchedBackgroundMigrations(requestParameters?: BatchedBackgroundMigrationsApiGetApiV4AdminBatchedBackgroundMigrationsRequest, options?: RawAxiosRequestConfig): AxiosPromise>;
/**
* Retrieve a batched background migration
* @param {BatchedBackgroundMigrationsApiGetApiV4AdminBatchedBackgroundMigrationsIdRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4AdminBatchedBackgroundMigrationsId(requestParameters: BatchedBackgroundMigrationsApiGetApiV4AdminBatchedBackgroundMigrationsIdRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Pause a batched background migration
* @param {BatchedBackgroundMigrationsApiPutApiV4AdminBatchedBackgroundMigrationsIdPauseRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
putApiV4AdminBatchedBackgroundMigrationsIdPause(requestParameters: BatchedBackgroundMigrationsApiPutApiV4AdminBatchedBackgroundMigrationsIdPauseRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Resume a batched background migration
* @param {BatchedBackgroundMigrationsApiPutApiV4AdminBatchedBackgroundMigrationsIdResumeRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
putApiV4AdminBatchedBackgroundMigrationsIdResume(requestParameters: BatchedBackgroundMigrationsApiPutApiV4AdminBatchedBackgroundMigrationsIdResumeRequest, options?: RawAxiosRequestConfig): AxiosPromise;
};
/**
* Request parameters for getApiV4AdminBatchedBackgroundMigrations operation in BatchedBackgroundMigrationsApi.
* @export
* @interface BatchedBackgroundMigrationsApiGetApiV4AdminBatchedBackgroundMigrationsRequest
*/
export interface BatchedBackgroundMigrationsApiGetApiV4AdminBatchedBackgroundMigrationsRequest {
/**
* The name of the database, the default `main`
* @type {'main' | 'ci' | 'embedding' | 'main_clusterwide' | 'geo'}
* @memberof BatchedBackgroundMigrationsApiGetApiV4AdminBatchedBackgroundMigrations
*/
readonly database?: GetApiV4AdminBatchedBackgroundMigrationsDatabaseEnum;
}
/**
* Request parameters for getApiV4AdminBatchedBackgroundMigrationsId operation in BatchedBackgroundMigrationsApi.
* @export
* @interface BatchedBackgroundMigrationsApiGetApiV4AdminBatchedBackgroundMigrationsIdRequest
*/
export interface BatchedBackgroundMigrationsApiGetApiV4AdminBatchedBackgroundMigrationsIdRequest {
/**
* The batched background migration id
* @type {number}
* @memberof BatchedBackgroundMigrationsApiGetApiV4AdminBatchedBackgroundMigrationsId
*/
readonly id: number;
/**
* The name of the database
* @type {'main' | 'ci' | 'embedding' | 'main_clusterwide' | 'geo'}
* @memberof BatchedBackgroundMigrationsApiGetApiV4AdminBatchedBackgroundMigrationsId
*/
readonly database?: GetApiV4AdminBatchedBackgroundMigrationsIdDatabaseEnum;
}
/**
* Request parameters for putApiV4AdminBatchedBackgroundMigrationsIdPause operation in BatchedBackgroundMigrationsApi.
* @export
* @interface BatchedBackgroundMigrationsApiPutApiV4AdminBatchedBackgroundMigrationsIdPauseRequest
*/
export interface BatchedBackgroundMigrationsApiPutApiV4AdminBatchedBackgroundMigrationsIdPauseRequest {
/**
* The batched background migration id
* @type {number}
* @memberof BatchedBackgroundMigrationsApiPutApiV4AdminBatchedBackgroundMigrationsIdPause
*/
readonly id: number;
/**
*
* @type {PutApiV4AdminBatchedBackgroundMigrationsIdResumeRequest}
* @memberof BatchedBackgroundMigrationsApiPutApiV4AdminBatchedBackgroundMigrationsIdPause
*/
readonly putApiV4AdminBatchedBackgroundMigrationsIdResumeRequest?: PutApiV4AdminBatchedBackgroundMigrationsIdResumeRequest;
}
/**
* Request parameters for putApiV4AdminBatchedBackgroundMigrationsIdResume operation in BatchedBackgroundMigrationsApi.
* @export
* @interface BatchedBackgroundMigrationsApiPutApiV4AdminBatchedBackgroundMigrationsIdResumeRequest
*/
export interface BatchedBackgroundMigrationsApiPutApiV4AdminBatchedBackgroundMigrationsIdResumeRequest {
/**
* The batched background migration id
* @type {number}
* @memberof BatchedBackgroundMigrationsApiPutApiV4AdminBatchedBackgroundMigrationsIdResume
*/
readonly id: number;
/**
*
* @type {PutApiV4AdminBatchedBackgroundMigrationsIdResumeRequest}
* @memberof BatchedBackgroundMigrationsApiPutApiV4AdminBatchedBackgroundMigrationsIdResume
*/
readonly putApiV4AdminBatchedBackgroundMigrationsIdResumeRequest?: PutApiV4AdminBatchedBackgroundMigrationsIdResumeRequest;
}
/**
* BatchedBackgroundMigrationsApi - object-oriented interface
* @export
* @class BatchedBackgroundMigrationsApi
* @extends {BaseAPI}
*/
export declare class BatchedBackgroundMigrationsApi extends BaseAPI {
/**
* Get the list of batched background migrations
* @param {BatchedBackgroundMigrationsApiGetApiV4AdminBatchedBackgroundMigrationsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BatchedBackgroundMigrationsApi
*/
getApiV4AdminBatchedBackgroundMigrations(requestParameters?: BatchedBackgroundMigrationsApiGetApiV4AdminBatchedBackgroundMigrationsRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Retrieve a batched background migration
* @param {BatchedBackgroundMigrationsApiGetApiV4AdminBatchedBackgroundMigrationsIdRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BatchedBackgroundMigrationsApi
*/
getApiV4AdminBatchedBackgroundMigrationsId(requestParameters: BatchedBackgroundMigrationsApiGetApiV4AdminBatchedBackgroundMigrationsIdRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Pause a batched background migration
* @param {BatchedBackgroundMigrationsApiPutApiV4AdminBatchedBackgroundMigrationsIdPauseRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BatchedBackgroundMigrationsApi
*/
putApiV4AdminBatchedBackgroundMigrationsIdPause(requestParameters: BatchedBackgroundMigrationsApiPutApiV4AdminBatchedBackgroundMigrationsIdPauseRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Resume a batched background migration
* @param {BatchedBackgroundMigrationsApiPutApiV4AdminBatchedBackgroundMigrationsIdResumeRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BatchedBackgroundMigrationsApi
*/
putApiV4AdminBatchedBackgroundMigrationsIdResume(requestParameters: BatchedBackgroundMigrationsApiPutApiV4AdminBatchedBackgroundMigrationsIdResumeRequest, options?: RawAxiosRequestConfig): Promise>;
}
/**
* @export
*/
export declare const GetApiV4AdminBatchedBackgroundMigrationsDatabaseEnum: {
readonly Main: "main";
readonly Ci: "ci";
readonly Embedding: "embedding";
readonly MainClusterwide: "main_clusterwide";
readonly Geo: "geo";
};
export type GetApiV4AdminBatchedBackgroundMigrationsDatabaseEnum = typeof GetApiV4AdminBatchedBackgroundMigrationsDatabaseEnum[keyof typeof GetApiV4AdminBatchedBackgroundMigrationsDatabaseEnum];
/**
* @export
*/
export declare const GetApiV4AdminBatchedBackgroundMigrationsIdDatabaseEnum: {
readonly Main: "main";
readonly Ci: "ci";
readonly Embedding: "embedding";
readonly MainClusterwide: "main_clusterwide";
readonly Geo: "geo";
};
export type GetApiV4AdminBatchedBackgroundMigrationsIdDatabaseEnum = typeof GetApiV4AdminBatchedBackgroundMigrationsIdDatabaseEnum[keyof typeof GetApiV4AdminBatchedBackgroundMigrationsIdDatabaseEnum];
/**
* BranchesApi - axios parameter creator
* @export
*/
export declare const BranchesApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Delete a branch
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {string} branch The name of the branch
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteApiV4ProjectsIdRepositoryBranchesBranch: (id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, branch: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Delete all merged branches
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteApiV4ProjectsIdRepositoryMergedBranches: (id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, options?: RawAxiosRequestConfig) => Promise;
/**
* Get a project repository branches
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {number} [page] Current page number
* @param {number} [perPage] Number of items per page
* @param {string} [search] Return list of branches matching the search criteria
* @param {string} [regex] Return list of branches matching the regex
* @param {GetApiV4ProjectsIdRepositoryBranchesSortEnum} [sort] Return list of branches sorted by the given field
* @param {string} [pageToken] Name of branch to start the pagination from
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4ProjectsIdRepositoryBranches: (id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, page?: number, perPage?: number, search?: string, regex?: string, sort?: GetApiV4ProjectsIdRepositoryBranchesSortEnum, pageToken?: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Get a single repository branch
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {number} branch
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4ProjectsIdRepositoryBranchesBranch: (id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, branch: number, options?: RawAxiosRequestConfig) => Promise;
/**
* Check if a branch exists
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {string} branch The name of the branch
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
headApiV4ProjectsIdRepositoryBranchesBranch: (id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, branch: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Create branch
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {string} branch The name of the branch
* @param {string} ref Create branch from commit sha or existing branch
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postApiV4ProjectsIdRepositoryBranches: (id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, branch: string, ref: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Protect a single branch
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {string} branch The name of the branch
* @param {PutApiV4ProjectsIdRepositoryBranchesBranchProtectRequest} [putApiV4ProjectsIdRepositoryBranchesBranchProtectRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
putApiV4ProjectsIdRepositoryBranchesBranchProtect: (id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, branch: string, putApiV4ProjectsIdRepositoryBranchesBranchProtectRequest?: PutApiV4ProjectsIdRepositoryBranchesBranchProtectRequest, options?: RawAxiosRequestConfig) => Promise;
/**
* Unprotect a single branch
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {string} branch The name of the branch
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
putApiV4ProjectsIdRepositoryBranchesBranchUnprotect: (id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, branch: string, options?: RawAxiosRequestConfig) => Promise;
};
/**
* BranchesApi - functional programming interface
* @export
*/
export declare const BranchesApiFp: (configuration?: Configuration) => {
/**
* Delete a branch
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {string} branch The name of the branch
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteApiV4ProjectsIdRepositoryBranchesBranch(id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, branch: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Delete all merged branches
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteApiV4ProjectsIdRepositoryMergedBranches(id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Get a project repository branches
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {number} [page] Current page number
* @param {number} [perPage] Number of items per page
* @param {string} [search] Return list of branches matching the search criteria
* @param {string} [regex] Return list of branches matching the regex
* @param {GetApiV4ProjectsIdRepositoryBranchesSortEnum} [sort] Return list of branches sorted by the given field
* @param {string} [pageToken] Name of branch to start the pagination from
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4ProjectsIdRepositoryBranches(id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, page?: number, perPage?: number, search?: string, regex?: string, sort?: GetApiV4ProjectsIdRepositoryBranchesSortEnum, pageToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>;
/**
* Get a single repository branch
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {number} branch
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4ProjectsIdRepositoryBranchesBranch(id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, branch: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Check if a branch exists
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {string} branch The name of the branch
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
headApiV4ProjectsIdRepositoryBranchesBranch(id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, branch: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Create branch
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {string} branch The name of the branch
* @param {string} ref Create branch from commit sha or existing branch
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postApiV4ProjectsIdRepositoryBranches(id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, branch: string, ref: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Protect a single branch
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {string} branch The name of the branch
* @param {PutApiV4ProjectsIdRepositoryBranchesBranchProtectRequest} [putApiV4ProjectsIdRepositoryBranchesBranchProtectRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
putApiV4ProjectsIdRepositoryBranchesBranchProtect(id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, branch: string, putApiV4ProjectsIdRepositoryBranchesBranchProtectRequest?: PutApiV4ProjectsIdRepositoryBranchesBranchProtectRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Unprotect a single branch
* @param {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter} id The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @param {string} branch The name of the branch
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
putApiV4ProjectsIdRepositoryBranchesBranchUnprotect(id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter, branch: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* BranchesApi - factory interface
* @export
*/
export declare const BranchesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Delete a branch
* @param {BranchesApiDeleteApiV4ProjectsIdRepositoryBranchesBranchRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteApiV4ProjectsIdRepositoryBranchesBranch(requestParameters: BranchesApiDeleteApiV4ProjectsIdRepositoryBranchesBranchRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Delete all merged branches
* @param {BranchesApiDeleteApiV4ProjectsIdRepositoryMergedBranchesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteApiV4ProjectsIdRepositoryMergedBranches(requestParameters: BranchesApiDeleteApiV4ProjectsIdRepositoryMergedBranchesRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Get a project repository branches
* @param {BranchesApiGetApiV4ProjectsIdRepositoryBranchesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4ProjectsIdRepositoryBranches(requestParameters: BranchesApiGetApiV4ProjectsIdRepositoryBranchesRequest, options?: RawAxiosRequestConfig): AxiosPromise>;
/**
* Get a single repository branch
* @param {BranchesApiGetApiV4ProjectsIdRepositoryBranchesBranchRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4ProjectsIdRepositoryBranchesBranch(requestParameters: BranchesApiGetApiV4ProjectsIdRepositoryBranchesBranchRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Check if a branch exists
* @param {BranchesApiHeadApiV4ProjectsIdRepositoryBranchesBranchRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
headApiV4ProjectsIdRepositoryBranchesBranch(requestParameters: BranchesApiHeadApiV4ProjectsIdRepositoryBranchesBranchRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Create branch
* @param {BranchesApiPostApiV4ProjectsIdRepositoryBranchesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postApiV4ProjectsIdRepositoryBranches(requestParameters: BranchesApiPostApiV4ProjectsIdRepositoryBranchesRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Protect a single branch
* @param {BranchesApiPutApiV4ProjectsIdRepositoryBranchesBranchProtectRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
putApiV4ProjectsIdRepositoryBranchesBranchProtect(requestParameters: BranchesApiPutApiV4ProjectsIdRepositoryBranchesBranchProtectRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Unprotect a single branch
* @param {BranchesApiPutApiV4ProjectsIdRepositoryBranchesBranchUnprotectRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
putApiV4ProjectsIdRepositoryBranchesBranchUnprotect(requestParameters: BranchesApiPutApiV4ProjectsIdRepositoryBranchesBranchUnprotectRequest, options?: RawAxiosRequestConfig): AxiosPromise;
};
/**
* Request parameters for deleteApiV4ProjectsIdRepositoryBranchesBranch operation in BranchesApi.
* @export
* @interface BranchesApiDeleteApiV4ProjectsIdRepositoryBranchesBranchRequest
*/
export interface BranchesApiDeleteApiV4ProjectsIdRepositoryBranchesBranchRequest {
/**
* The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @type {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter}
* @memberof BranchesApiDeleteApiV4ProjectsIdRepositoryBranchesBranch
*/
readonly id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter;
/**
* The name of the branch
* @type {string}
* @memberof BranchesApiDeleteApiV4ProjectsIdRepositoryBranchesBranch
*/
readonly branch: string;
}
/**
* Request parameters for deleteApiV4ProjectsIdRepositoryMergedBranches operation in BranchesApi.
* @export
* @interface BranchesApiDeleteApiV4ProjectsIdRepositoryMergedBranchesRequest
*/
export interface BranchesApiDeleteApiV4ProjectsIdRepositoryMergedBranchesRequest {
/**
* The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @type {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter}
* @memberof BranchesApiDeleteApiV4ProjectsIdRepositoryMergedBranches
*/
readonly id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter;
}
/**
* Request parameters for getApiV4ProjectsIdRepositoryBranches operation in BranchesApi.
* @export
* @interface BranchesApiGetApiV4ProjectsIdRepositoryBranchesRequest
*/
export interface BranchesApiGetApiV4ProjectsIdRepositoryBranchesRequest {
/**
* The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @type {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter}
* @memberof BranchesApiGetApiV4ProjectsIdRepositoryBranches
*/
readonly id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter;
/**
* Current page number
* @type {number}
* @memberof BranchesApiGetApiV4ProjectsIdRepositoryBranches
*/
readonly page?: number;
/**
* Number of items per page
* @type {number}
* @memberof BranchesApiGetApiV4ProjectsIdRepositoryBranches
*/
readonly perPage?: number;
/**
* Return list of branches matching the search criteria
* @type {string}
* @memberof BranchesApiGetApiV4ProjectsIdRepositoryBranches
*/
readonly search?: string;
/**
* Return list of branches matching the regex
* @type {string}
* @memberof BranchesApiGetApiV4ProjectsIdRepositoryBranches
*/
readonly regex?: string;
/**
* Return list of branches sorted by the given field
* @type {'name_asc' | 'updated_asc' | 'updated_desc'}
* @memberof BranchesApiGetApiV4ProjectsIdRepositoryBranches
*/
readonly sort?: GetApiV4ProjectsIdRepositoryBranchesSortEnum;
/**
* Name of branch to start the pagination from
* @type {string}
* @memberof BranchesApiGetApiV4ProjectsIdRepositoryBranches
*/
readonly pageToken?: string;
}
/**
* Request parameters for getApiV4ProjectsIdRepositoryBranchesBranch operation in BranchesApi.
* @export
* @interface BranchesApiGetApiV4ProjectsIdRepositoryBranchesBranchRequest
*/
export interface BranchesApiGetApiV4ProjectsIdRepositoryBranchesBranchRequest {
/**
* The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @type {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter}
* @memberof BranchesApiGetApiV4ProjectsIdRepositoryBranchesBranch
*/
readonly id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter;
/**
*
* @type {number}
* @memberof BranchesApiGetApiV4ProjectsIdRepositoryBranchesBranch
*/
readonly branch: number;
}
/**
* Request parameters for headApiV4ProjectsIdRepositoryBranchesBranch operation in BranchesApi.
* @export
* @interface BranchesApiHeadApiV4ProjectsIdRepositoryBranchesBranchRequest
*/
export interface BranchesApiHeadApiV4ProjectsIdRepositoryBranchesBranchRequest {
/**
* The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @type {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter}
* @memberof BranchesApiHeadApiV4ProjectsIdRepositoryBranchesBranch
*/
readonly id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter;
/**
* The name of the branch
* @type {string}
* @memberof BranchesApiHeadApiV4ProjectsIdRepositoryBranchesBranch
*/
readonly branch: string;
}
/**
* Request parameters for postApiV4ProjectsIdRepositoryBranches operation in BranchesApi.
* @export
* @interface BranchesApiPostApiV4ProjectsIdRepositoryBranchesRequest
*/
export interface BranchesApiPostApiV4ProjectsIdRepositoryBranchesRequest {
/**
* The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @type {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter}
* @memberof BranchesApiPostApiV4ProjectsIdRepositoryBranches
*/
readonly id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter;
/**
* The name of the branch
* @type {string}
* @memberof BranchesApiPostApiV4ProjectsIdRepositoryBranches
*/
readonly branch: string;
/**
* Create branch from commit sha or existing branch
* @type {string}
* @memberof BranchesApiPostApiV4ProjectsIdRepositoryBranches
*/
readonly ref: string;
}
/**
* Request parameters for putApiV4ProjectsIdRepositoryBranchesBranchProtect operation in BranchesApi.
* @export
* @interface BranchesApiPutApiV4ProjectsIdRepositoryBranchesBranchProtectRequest
*/
export interface BranchesApiPutApiV4ProjectsIdRepositoryBranchesBranchProtectRequest {
/**
* The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @type {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter}
* @memberof BranchesApiPutApiV4ProjectsIdRepositoryBranchesBranchProtect
*/
readonly id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter;
/**
* The name of the branch
* @type {string}
* @memberof BranchesApiPutApiV4ProjectsIdRepositoryBranchesBranchProtect
*/
readonly branch: string;
/**
*
* @type {PutApiV4ProjectsIdRepositoryBranchesBranchProtectRequest}
* @memberof BranchesApiPutApiV4ProjectsIdRepositoryBranchesBranchProtect
*/
readonly putApiV4ProjectsIdRepositoryBranchesBranchProtectRequest?: PutApiV4ProjectsIdRepositoryBranchesBranchProtectRequest;
}
/**
* Request parameters for putApiV4ProjectsIdRepositoryBranchesBranchUnprotect operation in BranchesApi.
* @export
* @interface BranchesApiPutApiV4ProjectsIdRepositoryBranchesBranchUnprotectRequest
*/
export interface BranchesApiPutApiV4ProjectsIdRepositoryBranchesBranchUnprotectRequest {
/**
* The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
* @type {DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter}
* @memberof BranchesApiPutApiV4ProjectsIdRepositoryBranchesBranchUnprotect
*/
readonly id: DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter;
/**
* The name of the branch
* @type {string}
* @memberof BranchesApiPutApiV4ProjectsIdRepositoryBranchesBranchUnprotect
*/
readonly branch: string;
}
/**
* BranchesApi - object-oriented interface
* @export
* @class BranchesApi
* @extends {BaseAPI}
*/
export declare class BranchesApi extends BaseAPI {
/**
* Delete a branch
* @param {BranchesApiDeleteApiV4ProjectsIdRepositoryBranchesBranchRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BranchesApi
*/
deleteApiV4ProjectsIdRepositoryBranchesBranch(requestParameters: BranchesApiDeleteApiV4ProjectsIdRepositoryBranchesBranchRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Delete all merged branches
* @param {BranchesApiDeleteApiV4ProjectsIdRepositoryMergedBranchesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BranchesApi
*/
deleteApiV4ProjectsIdRepositoryMergedBranches(requestParameters: BranchesApiDeleteApiV4ProjectsIdRepositoryMergedBranchesRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Get a project repository branches
* @param {BranchesApiGetApiV4ProjectsIdRepositoryBranchesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BranchesApi
*/
getApiV4ProjectsIdRepositoryBranches(requestParameters: BranchesApiGetApiV4ProjectsIdRepositoryBranchesRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Get a single repository branch
* @param {BranchesApiGetApiV4ProjectsIdRepositoryBranchesBranchRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BranchesApi
*/
getApiV4ProjectsIdRepositoryBranchesBranch(requestParameters: BranchesApiGetApiV4ProjectsIdRepositoryBranchesBranchRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Check if a branch exists
* @param {BranchesApiHeadApiV4ProjectsIdRepositoryBranchesBranchRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BranchesApi
*/
headApiV4ProjectsIdRepositoryBranchesBranch(requestParameters: BranchesApiHeadApiV4ProjectsIdRepositoryBranchesBranchRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Create branch
* @param {BranchesApiPostApiV4ProjectsIdRepositoryBranchesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BranchesApi
*/
postApiV4ProjectsIdRepositoryBranches(requestParameters: BranchesApiPostApiV4ProjectsIdRepositoryBranchesRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Protect a single branch
* @param {BranchesApiPutApiV4ProjectsIdRepositoryBranchesBranchProtectRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BranchesApi
*/
putApiV4ProjectsIdRepositoryBranchesBranchProtect(requestParameters: BranchesApiPutApiV4ProjectsIdRepositoryBranchesBranchProtectRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Unprotect a single branch
* @param {BranchesApiPutApiV4ProjectsIdRepositoryBranchesBranchUnprotectRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BranchesApi
*/
putApiV4ProjectsIdRepositoryBranchesBranchUnprotect(requestParameters: BranchesApiPutApiV4ProjectsIdRepositoryBranchesBranchUnprotectRequest, options?: RawAxiosRequestConfig): Promise>;
}
/**
* @export
*/
export declare const GetApiV4ProjectsIdRepositoryBranchesSortEnum: {
readonly NameAsc: "name_asc";
readonly UpdatedAsc: "updated_asc";
readonly UpdatedDesc: "updated_desc";
};
export type GetApiV4ProjectsIdRepositoryBranchesSortEnum = typeof GetApiV4ProjectsIdRepositoryBranchesSortEnum[keyof typeof GetApiV4ProjectsIdRepositoryBranchesSortEnum];
/**
* BroadcastMessagesApi - axios parameter creator
* @export
*/
export declare const BroadcastMessagesApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* This feature was introduced in GitLab 8.12.
* @summary Delete a broadcast message
* @param {number} id Broadcast message ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteApiV4BroadcastMessagesId: (id: number, options?: RawAxiosRequestConfig) => Promise;
/**
* This feature was introduced in GitLab 8.12.
* @summary Get all broadcast messages
* @param {number} [page] Current page number
* @param {number} [perPage] Number of items per page
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4BroadcastMessages: (page?: number, perPage?: number, options?: RawAxiosRequestConfig) => Promise;
/**
* This feature was introduced in GitLab 8.12.
* @summary Get a specific broadcast message
* @param {number} id Broadcast message ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4BroadcastMessagesId: (id: number, options?: RawAxiosRequestConfig) => Promise;
/**
* This feature was introduced in GitLab 8.12.
* @summary Create a broadcast message
* @param {PostApiV4BroadcastMessagesRequest} postApiV4BroadcastMessagesRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postApiV4BroadcastMessages: (postApiV4BroadcastMessagesRequest: PostApiV4BroadcastMessagesRequest, options?: RawAxiosRequestConfig) => Promise;
/**
* This feature was introduced in GitLab 8.12.
* @summary Update a broadcast message
* @param {number} id Broadcast message ID
* @param {PutApiV4BroadcastMessagesIdRequest} [putApiV4BroadcastMessagesIdRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
putApiV4BroadcastMessagesId: (id: number, putApiV4BroadcastMessagesIdRequest?: PutApiV4BroadcastMessagesIdRequest, options?: RawAxiosRequestConfig) => Promise;
};
/**
* BroadcastMessagesApi - functional programming interface
* @export
*/
export declare const BroadcastMessagesApiFp: (configuration?: Configuration) => {
/**
* This feature was introduced in GitLab 8.12.
* @summary Delete a broadcast message
* @param {number} id Broadcast message ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteApiV4BroadcastMessagesId(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* This feature was introduced in GitLab 8.12.
* @summary Get all broadcast messages
* @param {number} [page] Current page number
* @param {number} [perPage] Number of items per page
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4BroadcastMessages(page?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* This feature was introduced in GitLab 8.12.
* @summary Get a specific broadcast message
* @param {number} id Broadcast message ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4BroadcastMessagesId(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* This feature was introduced in GitLab 8.12.
* @summary Create a broadcast message
* @param {PostApiV4BroadcastMessagesRequest} postApiV4BroadcastMessagesRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postApiV4BroadcastMessages(postApiV4BroadcastMessagesRequest: PostApiV4BroadcastMessagesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* This feature was introduced in GitLab 8.12.
* @summary Update a broadcast message
* @param {number} id Broadcast message ID
* @param {PutApiV4BroadcastMessagesIdRequest} [putApiV4BroadcastMessagesIdRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
putApiV4BroadcastMessagesId(id: number, putApiV4BroadcastMessagesIdRequest?: PutApiV4BroadcastMessagesIdRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* BroadcastMessagesApi - factory interface
* @export
*/
export declare const BroadcastMessagesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* This feature was introduced in GitLab 8.12.
* @summary Delete a broadcast message
* @param {BroadcastMessagesApiDeleteApiV4BroadcastMessagesIdRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteApiV4BroadcastMessagesId(requestParameters: BroadcastMessagesApiDeleteApiV4BroadcastMessagesIdRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* This feature was introduced in GitLab 8.12.
* @summary Get all broadcast messages
* @param {BroadcastMessagesApiGetApiV4BroadcastMessagesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4BroadcastMessages(requestParameters?: BroadcastMessagesApiGetApiV4BroadcastMessagesRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* This feature was introduced in GitLab 8.12.
* @summary Get a specific broadcast message
* @param {BroadcastMessagesApiGetApiV4BroadcastMessagesIdRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4BroadcastMessagesId(requestParameters: BroadcastMessagesApiGetApiV4BroadcastMessagesIdRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* This feature was introduced in GitLab 8.12.
* @summary Create a broadcast message
* @param {BroadcastMessagesApiPostApiV4BroadcastMessagesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postApiV4BroadcastMessages(requestParameters: BroadcastMessagesApiPostApiV4BroadcastMessagesRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* This feature was introduced in GitLab 8.12.
* @summary Update a broadcast message
* @param {BroadcastMessagesApiPutApiV4BroadcastMessagesIdRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
putApiV4BroadcastMessagesId(requestParameters: BroadcastMessagesApiPutApiV4BroadcastMessagesIdRequest, options?: RawAxiosRequestConfig): AxiosPromise;
};
/**
* Request parameters for deleteApiV4BroadcastMessagesId operation in BroadcastMessagesApi.
* @export
* @interface BroadcastMessagesApiDeleteApiV4BroadcastMessagesIdRequest
*/
export interface BroadcastMessagesApiDeleteApiV4BroadcastMessagesIdRequest {
/**
* Broadcast message ID
* @type {number}
* @memberof BroadcastMessagesApiDeleteApiV4BroadcastMessagesId
*/
readonly id: number;
}
/**
* Request parameters for getApiV4BroadcastMessages operation in BroadcastMessagesApi.
* @export
* @interface BroadcastMessagesApiGetApiV4BroadcastMessagesRequest
*/
export interface BroadcastMessagesApiGetApiV4BroadcastMessagesRequest {
/**
* Current page number
* @type {number}
* @memberof BroadcastMessagesApiGetApiV4BroadcastMessages
*/
readonly page?: number;
/**
* Number of items per page
* @type {number}
* @memberof BroadcastMessagesApiGetApiV4BroadcastMessages
*/
readonly perPage?: number;
}
/**
* Request parameters for getApiV4BroadcastMessagesId operation in BroadcastMessagesApi.
* @export
* @interface BroadcastMessagesApiGetApiV4BroadcastMessagesIdRequest
*/
export interface BroadcastMessagesApiGetApiV4BroadcastMessagesIdRequest {
/**
* Broadcast message ID
* @type {number}
* @memberof BroadcastMessagesApiGetApiV4BroadcastMessagesId
*/
readonly id: number;
}
/**
* Request parameters for postApiV4BroadcastMessages operation in BroadcastMessagesApi.
* @export
* @interface BroadcastMessagesApiPostApiV4BroadcastMessagesRequest
*/
export interface BroadcastMessagesApiPostApiV4BroadcastMessagesRequest {
/**
*
* @type {PostApiV4BroadcastMessagesRequest}
* @memberof BroadcastMessagesApiPostApiV4BroadcastMessages
*/
readonly postApiV4BroadcastMessagesRequest: PostApiV4BroadcastMessagesRequest;
}
/**
* Request parameters for putApiV4BroadcastMessagesId operation in BroadcastMessagesApi.
* @export
* @interface BroadcastMessagesApiPutApiV4BroadcastMessagesIdRequest
*/
export interface BroadcastMessagesApiPutApiV4BroadcastMessagesIdRequest {
/**
* Broadcast message ID
* @type {number}
* @memberof BroadcastMessagesApiPutApiV4BroadcastMessagesId
*/
readonly id: number;
/**
*
* @type {PutApiV4BroadcastMessagesIdRequest}
* @memberof BroadcastMessagesApiPutApiV4BroadcastMessagesId
*/
readonly putApiV4BroadcastMessagesIdRequest?: PutApiV4BroadcastMessagesIdRequest;
}
/**
* BroadcastMessagesApi - object-oriented interface
* @export
* @class BroadcastMessagesApi
* @extends {BaseAPI}
*/
export declare class BroadcastMessagesApi extends BaseAPI {
/**
* This feature was introduced in GitLab 8.12.
* @summary Delete a broadcast message
* @param {BroadcastMessagesApiDeleteApiV4BroadcastMessagesIdRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BroadcastMessagesApi
*/
deleteApiV4BroadcastMessagesId(requestParameters: BroadcastMessagesApiDeleteApiV4BroadcastMessagesIdRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* This feature was introduced in GitLab 8.12.
* @summary Get all broadcast messages
* @param {BroadcastMessagesApiGetApiV4BroadcastMessagesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BroadcastMessagesApi
*/
getApiV4BroadcastMessages(requestParameters?: BroadcastMessagesApiGetApiV4BroadcastMessagesRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* This feature was introduced in GitLab 8.12.
* @summary Get a specific broadcast message
* @param {BroadcastMessagesApiGetApiV4BroadcastMessagesIdRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BroadcastMessagesApi
*/
getApiV4BroadcastMessagesId(requestParameters: BroadcastMessagesApiGetApiV4BroadcastMessagesIdRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* This feature was introduced in GitLab 8.12.
* @summary Create a broadcast message
* @param {BroadcastMessagesApiPostApiV4BroadcastMessagesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BroadcastMessagesApi
*/
postApiV4BroadcastMessages(requestParameters: BroadcastMessagesApiPostApiV4BroadcastMessagesRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* This feature was introduced in GitLab 8.12.
* @summary Update a broadcast message
* @param {BroadcastMessagesApiPutApiV4BroadcastMessagesIdRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BroadcastMessagesApi
*/
putApiV4BroadcastMessagesId(requestParameters: BroadcastMessagesApiPutApiV4BroadcastMessagesIdRequest, options?: RawAxiosRequestConfig): Promise>;
}
/**
* BulkImportsApi - axios parameter creator
* @export
*/
export declare const BulkImportsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* This feature was introduced in GitLab 14.1.
* @summary List all GitLab Migrations
* @param {number} [page] Current page number
* @param {number} [perPage] Number of items per page
* @param {GetApiV4BulkImportsSortEnum} [sort] Return GitLab Migrations sorted in created by `asc` or `desc` order.
* @param {GetApiV4BulkImportsStatusEnum} [status] Return GitLab Migrations with specified status
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4BulkImports: (page?: number, perPage?: number, sort?: GetApiV4BulkImportsSortEnum, status?: GetApiV4BulkImportsStatusEnum, options?: RawAxiosRequestConfig) => Promise;
/**
* This feature was introduced in GitLab 14.1.
* @summary List all GitLab Migrations\' entities
* @param {number} [page] Current page number
* @param {number} [perPage] Number of items per page
* @param {GetApiV4BulkImportsEntitiesSortEnum} [sort] Return GitLab Migrations sorted in created by `asc` or `desc` order.
* @param {GetApiV4BulkImportsEntitiesStatusEnum} [status] Return all GitLab Migrations\' entities with specified status
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4BulkImportsEntities: (page?: number, perPage?: number, sort?: GetApiV4BulkImportsEntitiesSortEnum, status?: GetApiV4BulkImportsEntitiesStatusEnum, options?: RawAxiosRequestConfig) => Promise;
/**
* This feature was introduced in GitLab 14.1.
* @summary Get GitLab Migration details
* @param {number} importId The ID of user\'s GitLab Migration
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4BulkImportsImportId: (importId: number, options?: RawAxiosRequestConfig) => Promise;
/**
* This feature was introduced in GitLab 14.1.
* @summary List GitLab Migration entities
* @param {number} importId The ID of user\'s GitLab Migration
* @param {GetApiV4BulkImportsImportIdEntitiesStatusEnum} [status] Return import entities with specified status
* @param {number} [page] Current page number
* @param {number} [perPage] Number of items per page
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4BulkImportsImportIdEntities: (importId: number, status?: GetApiV4BulkImportsImportIdEntitiesStatusEnum, page?: number, perPage?: number, options?: RawAxiosRequestConfig) => Promise;
/**
* This feature was introduced in GitLab 14.1.
* @summary Get GitLab Migration entity details
* @param {number} importId The ID of user\'s GitLab Migration
* @param {number} entityId The ID of GitLab Migration entity
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4BulkImportsImportIdEntitiesEntityId: (importId: number, entityId: number, options?: RawAxiosRequestConfig) => Promise;
/**
* This feature was introduced in GitLab 14.2.
* @summary Start a new GitLab Migration
* @param {string} configurationUrl Source GitLab instance URL
* @param {string} configurationAccessToken Access token to the source GitLab instance
* @param {Array} entitiesSourceType Source entity type
* @param {Array} entitiesSourceFullPath Relative path of the source entity to import
* @param {Array} entitiesDestinationNamespace Destination namespace for the entity
* @param {Array} [entitiesDestinationSlug] Destination slug for the entity
* @param {Array} [entitiesDestinationName] Deprecated: Use :destination_slug instead. Destination slug for the entity
* @param {Array} [entitiesMigrateProjects] Indicates group migration should include nested projects
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postApiV4BulkImports: (configurationUrl: string, configurationAccessToken: string, entitiesSourceType: Array, entitiesSourceFullPath: Array, entitiesDestinationNamespace: Array, entitiesDestinationSlug?: Array, entitiesDestinationName?: Array, entitiesMigrateProjects?: Array, options?: RawAxiosRequestConfig) => Promise;
};
/**
* BulkImportsApi - functional programming interface
* @export
*/
export declare const BulkImportsApiFp: (configuration?: Configuration) => {
/**
* This feature was introduced in GitLab 14.1.
* @summary List all GitLab Migrations
* @param {number} [page] Current page number
* @param {number} [perPage] Number of items per page
* @param {GetApiV4BulkImportsSortEnum} [sort] Return GitLab Migrations sorted in created by `asc` or `desc` order.
* @param {GetApiV4BulkImportsStatusEnum} [status] Return GitLab Migrations with specified status
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4BulkImports(page?: number, perPage?: number, sort?: GetApiV4BulkImportsSortEnum, status?: GetApiV4BulkImportsStatusEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>;
/**
* This feature was introduced in GitLab 14.1.
* @summary List all GitLab Migrations\' entities
* @param {number} [page] Current page number
* @param {number} [perPage] Number of items per page
* @param {GetApiV4BulkImportsEntitiesSortEnum} [sort] Return GitLab Migrations sorted in created by `asc` or `desc` order.
* @param {GetApiV4BulkImportsEntitiesStatusEnum} [status] Return all GitLab Migrations\' entities with specified status
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4BulkImportsEntities(page?: number, perPage?: number, sort?: GetApiV4BulkImportsEntitiesSortEnum, status?: GetApiV4BulkImportsEntitiesStatusEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>;
/**
* This feature was introduced in GitLab 14.1.
* @summary Get GitLab Migration details
* @param {number} importId The ID of user\'s GitLab Migration
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4BulkImportsImportId(importId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* This feature was introduced in GitLab 14.1.
* @summary List GitLab Migration entities
* @param {number} importId The ID of user\'s GitLab Migration
* @param {GetApiV4BulkImportsImportIdEntitiesStatusEnum} [status] Return import entities with specified status
* @param {number} [page] Current page number
* @param {number} [perPage] Number of items per page
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4BulkImportsImportIdEntities(importId: number, status?: GetApiV4BulkImportsImportIdEntitiesStatusEnum, page?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>;
/**
* This feature was introduced in GitLab 14.1.
* @summary Get GitLab Migration entity details
* @param {number} importId The ID of user\'s GitLab Migration
* @param {number} entityId The ID of GitLab Migration entity
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4BulkImportsImportIdEntitiesEntityId(importId: number, entityId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* This feature was introduced in GitLab 14.2.
* @summary Start a new GitLab Migration
* @param {string} configurationUrl Source GitLab instance URL
* @param {string} configurationAccessToken Access token to the source GitLab instance
* @param {Array} entitiesSourceType Source entity type
* @param {Array} entitiesSourceFullPath Relative path of the source entity to import
* @param {Array} entitiesDestinationNamespace Destination namespace for the entity
* @param {Array} [entitiesDestinationSlug] Destination slug for the entity
* @param {Array} [entitiesDestinationName] Deprecated: Use :destination_slug instead. Destination slug for the entity
* @param {Array} [entitiesMigrateProjects] Indicates group migration should include nested projects
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postApiV4BulkImports(configurationUrl: string, configurationAccessToken: string, entitiesSourceType: Array, entitiesSourceFullPath: Array, entitiesDestinationNamespace: Array, entitiesDestinationSlug?: Array, entitiesDestinationName?: Array, entitiesMigrateProjects?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* BulkImportsApi - factory interface
* @export
*/
export declare const BulkImportsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* This feature was introduced in GitLab 14.1.
* @summary List all GitLab Migrations
* @param {BulkImportsApiGetApiV4BulkImportsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4BulkImports(requestParameters?: BulkImportsApiGetApiV4BulkImportsRequest, options?: RawAxiosRequestConfig): AxiosPromise>;
/**
* This feature was introduced in GitLab 14.1.
* @summary List all GitLab Migrations\' entities
* @param {BulkImportsApiGetApiV4BulkImportsEntitiesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4BulkImportsEntities(requestParameters?: BulkImportsApiGetApiV4BulkImportsEntitiesRequest, options?: RawAxiosRequestConfig): AxiosPromise>;
/**
* This feature was introduced in GitLab 14.1.
* @summary Get GitLab Migration details
* @param {BulkImportsApiGetApiV4BulkImportsImportIdRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4BulkImportsImportId(requestParameters: BulkImportsApiGetApiV4BulkImportsImportIdRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* This feature was introduced in GitLab 14.1.
* @summary List GitLab Migration entities
* @param {BulkImportsApiGetApiV4BulkImportsImportIdEntitiesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4BulkImportsImportIdEntities(requestParameters: BulkImportsApiGetApiV4BulkImportsImportIdEntitiesRequest, options?: RawAxiosRequestConfig): AxiosPromise>;
/**
* This feature was introduced in GitLab 14.1.
* @summary Get GitLab Migration entity details
* @param {BulkImportsApiGetApiV4BulkImportsImportIdEntitiesEntityIdRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApiV4BulkImportsImportIdEntitiesEntityId(requestParameters: BulkImportsApiGetApiV4BulkImportsImportIdEntitiesEntityIdRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* This feature was introduced in GitLab 14.2.
* @summary Start a new GitLab Migration
* @param {BulkImportsApiPostApiV4BulkImportsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postApiV4BulkImports(requestParameters: BulkImportsApiPostApiV4BulkImportsRequest, options?: RawAxiosRequestConfig): AxiosPromise;
};
/**
* Request parameters for getApiV4BulkImports operation in BulkImportsApi.
* @export
* @interface BulkImportsApiGetApiV4BulkImportsRequest
*/
export interface BulkImportsApiGetApiV4BulkImportsRequest {
/**
* Current page number
* @type {number}
* @memberof BulkImportsApiGetApiV4BulkImports
*/
readonly page?: number;
/**
* Number of items per page
* @type {number}
* @memberof BulkImportsApiGetApiV4BulkImports
*/
readonly perPage?: number;
/**
* Return GitLab Migrations sorted in created by `asc` or `desc` order.
* @type {'asc' | 'desc'}
* @memberof BulkImportsApiGetApiV4BulkImports
*/
readonly sort?: GetApiV4BulkImportsSortEnum;
/**
* Return GitLab Migrations with specified status
* @type {'created' | 'started' | 'finished' | 'timeout' | 'failed'}
* @memberof BulkImportsApiGetApiV4BulkImports
*/
readonly status?: GetApiV4BulkImportsStatusEnum;
}
/**
* Request parameters for getApiV4BulkImportsEntities operation in BulkImportsApi.
* @export
* @interface BulkImportsApiGetApiV4BulkImportsEntitiesRequest
*/
export interface BulkImportsApiGetApiV4BulkImportsEntitiesRequest {
/**
* Current page number
* @type {number}
* @memberof BulkImportsApiGetApiV4BulkImportsEntities
*/
readonly page?: number;
/**
* Number of items per page
* @type {number}
* @memberof BulkImportsApiGetApiV4BulkImportsEntities
*/
readonly perPage?: number;
/**
* Return GitLab Migrations sorted in created by `asc` or `desc` order.
* @type {'asc' | 'desc'}
* @memberof BulkImportsApiGetApiV4BulkImportsEntities
*/
readonly sort?: GetApiV4BulkImportsEntitiesSortEnum;
/**
* Return all GitLab Migrations\' entities with specified status
* @type {'created' | 'started' | 'finished' | 'timeout' | 'failed'}
* @memberof BulkImportsApiGetApiV4BulkImportsEntities
*/
readonly status?: GetApiV4BulkImportsEntitiesStatusEnum;
}
/**
* Request parameters for getApiV4BulkImportsImportId operation in BulkImportsApi.
* @export
* @interface BulkImportsApiGetApiV4BulkImportsImportIdRequest
*/
export interface BulkImportsApiGetApiV4BulkImportsImportIdRequest {
/**
* The ID of user\'s GitLab Migration
* @type {number}
* @memberof BulkImportsApiGetApiV4BulkImportsImportId
*/
readonly importId: number;
}
/**
* Request parameters for getApiV4BulkImportsImportIdEntities operation in BulkImportsApi.
* @export
* @interface BulkImportsApiGetApiV4BulkImportsImportIdEntitiesRequest
*/
export interface BulkImportsApiGetApiV4BulkImportsImportIdEntitiesRequest {
/**
* The ID of user\'s GitLab Migration
* @type {number}
* @memberof BulkImportsApiGetApiV4BulkImportsImportIdEntities
*/
readonly importId: number;
/**
* Return import entities with specified status
* @type {'created' | 'started' | 'finished' | 'timeout' | 'failed'}
* @memberof BulkImportsApiGetApiV4BulkImportsImportIdEntities
*/
readonly status?: GetApiV4BulkImportsImportIdEntitiesStatusEnum;
/**
* Current page number
* @type {number}
* @memberof BulkImportsApiGetApiV4BulkImportsImportIdEntities
*/
readonly page?: number;
/**
* Number of items per page
* @type {number}
* @memberof BulkImportsApiGetApiV4BulkImportsImportIdEntities
*/
readonly perPage?: number;
}
/**
* Request parameters for getApiV4BulkImportsImportIdEntitiesEntityId operation in BulkImportsApi.
* @export
* @interface BulkImportsApiGetApiV4BulkImportsImportIdEntitiesEntityIdRequest
*/
export interface BulkImportsApiGetApiV4BulkImportsImportIdEntitiesEntityIdRequest {
/**
* The ID of user\'s GitLab Migration
* @type {number}
* @memberof BulkImportsApiGetApiV4BulkImportsImportIdEntitiesEntityId
*/
readonly importId: number;
/**
* The ID of GitLab Migration entity
* @type {number}
* @memberof BulkImportsApiGetApiV4BulkImportsImportIdEntitiesEntityId
*/
readonly entityId: number;
}
/**
* Request parameters for postApiV4BulkImports operation in BulkImportsApi.
* @export
* @interface BulkImportsApiPostApiV4BulkImportsRequest
*/
export interface BulkImportsApiPostApiV4BulkImportsRequest {
/**
* Source GitLab instance URL
* @type {string}
* @memberof BulkImportsApiPostApiV4BulkImports
*/
readonly configurationUrl: string;
/**
* Access token to the source GitLab instance
* @type {string}
* @memberof BulkImportsApiPostApiV4BulkImports
*/
readonly configurationAccessToken: string;
/**
* Source entity type
* @type {Array