glabc

## berg@v4 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: Environment * Node.js * Webpack * Browserify Language level * ES5 - you must have a Promises/A+ library installed * ES6 Module system * CommonJS * ES6 module system It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) ### Building To build and compile the typescript sources to javascript use: ``` npm install npm run build ``` ### Publishing First build the package then run `npm publish` ### Consuming navigate to the folder of your consuming project and run one of the following commands. _published:_ ``` npm install berg@v4 --save ``` _unPublished (not recommended):_ ``` npm install PATH_TO_GENERATED_PACKAGE --save ``` ### Documentation for API Endpoints All URIs are relative to *https://www.gitlab.com/api/v4* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- *AccessRequestsApi* | [**deleteApiV4GroupsIdAccessRequestsUserId**](docs/AccessRequestsApi.md#deleteapiv4groupsidaccessrequestsuserid) | **DELETE** /groups/{id}/access_requests/{user_id} | Denies an access request for the given user. *AccessRequestsApi* | [**deleteApiV4ProjectsIdAccessRequestsUserId**](docs/AccessRequestsApi.md#deleteapiv4projectsidaccessrequestsuserid) | **DELETE** /projects/{id}/access_requests/{user_id} | Denies an access request for the given user. *AccessRequestsApi* | [**getApiV4GroupsIdAccessRequests**](docs/AccessRequestsApi.md#getapiv4groupsidaccessrequests) | **GET** /groups/{id}/access_requests | Gets a list of access requests for a group. *AccessRequestsApi* | [**getApiV4ProjectsIdAccessRequests**](docs/AccessRequestsApi.md#getapiv4projectsidaccessrequests) | **GET** /projects/{id}/access_requests | Gets a list of access requests for a project. *AccessRequestsApi* | [**postApiV4GroupsIdAccessRequests**](docs/AccessRequestsApi.md#postapiv4groupsidaccessrequests) | **POST** /groups/{id}/access_requests | Requests access for the authenticated user to a group. *AccessRequestsApi* | [**postApiV4ProjectsIdAccessRequests**](docs/AccessRequestsApi.md#postapiv4projectsidaccessrequests) | **POST** /projects/{id}/access_requests | Requests access for the authenticated user to a project. *AccessRequestsApi* | [**putApiV4GroupsIdAccessRequestsUserIdApprove**](docs/AccessRequestsApi.md#putapiv4groupsidaccessrequestsuseridapprove) | **PUT** /groups/{id}/access_requests/{user_id}/approve | Approves an access request for the given user. *AccessRequestsApi* | [**putApiV4ProjectsIdAccessRequestsUserIdApprove**](docs/AccessRequestsApi.md#putapiv4projectsidaccessrequestsuseridapprove) | **PUT** /projects/{id}/access_requests/{user_id}/approve | Approves an access request for the given user. *AdminApi* | [**getApiV4AdminDatabasesDatabaseNameDictionaryTablesTableName**](docs/AdminApi.md#getapiv4admindatabasesdatabasenamedictionarytablestablename) | **GET** /admin/databases/{database_name}/dictionary/tables/{table_name} | *AlertManagementApi* | [**deleteApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageId**](docs/AlertManagementApi.md#deleteapiv4projectsidalertmanagementalertsalertiidmetricimagesmetricimageid) | **DELETE** /projects/{id}/alert_management_alerts/{alert_iid}/metric_images/{metric_image_id} | *AlertManagementApi* | [**getApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImages**](docs/AlertManagementApi.md#getapiv4projectsidalertmanagementalertsalertiidmetricimages) | **GET** /projects/{id}/alert_management_alerts/{alert_iid}/metric_images | *AlertManagementApi* | [**postApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImages**](docs/AlertManagementApi.md#postapiv4projectsidalertmanagementalertsalertiidmetricimages) | **POST** /projects/{id}/alert_management_alerts/{alert_iid}/metric_images | *AlertManagementApi* | [**postApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesAuthorize**](docs/AlertManagementApi.md#postapiv4projectsidalertmanagementalertsalertiidmetricimagesauthorize) | **POST** /projects/{id}/alert_management_alerts/{alert_iid}/metric_images/authorize | *AlertManagementApi* | [**putApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageId**](docs/AlertManagementApi.md#putapiv4projectsidalertmanagementalertsalertiidmetricimagesmetricimageid) | **PUT** /projects/{id}/alert_management_alerts/{alert_iid}/metric_images/{metric_image_id} | *ApplicationApi* | [**getApiV4ApplicationAppearance**](docs/ApplicationApi.md#getapiv4applicationappearance) | **GET** /application/appearance | *ApplicationApi* | [**putApiV4ApplicationAppearance**](docs/ApplicationApi.md#putapiv4applicationappearance) | **PUT** /application/appearance | *ApplicationsApi* | [**deleteApiV4ApplicationsId**](docs/ApplicationsApi.md#deleteapiv4applicationsid) | **DELETE** /applications/{id} | Delete an application *ApplicationsApi* | [**getApiV4Applications**](docs/ApplicationsApi.md#getapiv4applications) | **GET** /applications | Get applications *ApplicationsApi* | [**postApiV4Applications**](docs/ApplicationsApi.md#postapiv4applications) | **POST** /applications | Create a new application *AvatarApi* | [**getApiV4Avatar**](docs/AvatarApi.md#getapiv4avatar) | **GET** /avatar | *BadgesApi* | [**deleteApiV4GroupsIdBadgesBadgeId**](docs/BadgesApi.md#deleteapiv4groupsidbadgesbadgeid) | **DELETE** /groups/{id}/badges/{badge_id} | Removes a badge from the group. *BadgesApi* | [**deleteApiV4ProjectsIdBadgesBadgeId**](docs/BadgesApi.md#deleteapiv4projectsidbadgesbadgeid) | **DELETE** /projects/{id}/badges/{badge_id} | Removes a badge from the project. *BadgesApi* | [**getApiV4GroupsIdBadges**](docs/BadgesApi.md#getapiv4groupsidbadges) | **GET** /groups/{id}/badges | Gets a list of group badges viewable by the authenticated user. *BadgesApi* | [**getApiV4GroupsIdBadgesBadgeId**](docs/BadgesApi.md#getapiv4groupsidbadgesbadgeid) | **GET** /groups/{id}/badges/{badge_id} | Gets a badge of a group. *BadgesApi* | [**getApiV4GroupsIdBadgesRender**](docs/BadgesApi.md#getapiv4groupsidbadgesrender) | **GET** /groups/{id}/badges/render | Preview a badge from a group. *BadgesApi* | [**getApiV4ProjectsIdBadges**](docs/BadgesApi.md#getapiv4projectsidbadges) | **GET** /projects/{id}/badges | Gets a list of project badges viewable by the authenticated user. *BadgesApi* | [**getApiV4ProjectsIdBadgesBadgeId**](docs/BadgesApi.md#getapiv4projectsidbadgesbadgeid) | **GET** /projects/{id}/badges/{badge_id} | Gets a badge of a project. *BadgesApi* | [**getApiV4ProjectsIdBadgesRender**](docs/BadgesApi.md#getapiv4projectsidbadgesrender) | **GET** /projects/{id}/badges/render | Preview a badge from a project. *BadgesApi* | [**postApiV4GroupsIdBadges**](docs/BadgesApi.md#postapiv4groupsidbadges) | **POST** /groups/{id}/badges | Adds a badge to a group. *BadgesApi* | [**postApiV4ProjectsIdBadges**](docs/BadgesApi.md#postapiv4projectsidbadges) | **POST** /projects/{id}/badges | Adds a badge to a project. *BadgesApi* | [**putApiV4GroupsIdBadgesBadgeId**](docs/BadgesApi.md#putapiv4groupsidbadgesbadgeid) | **PUT** /groups/{id}/badges/{badge_id} | Updates a badge of a group. *BadgesApi* | [**putApiV4ProjectsIdBadgesBadgeId**](docs/BadgesApi.md#putapiv4projectsidbadgesbadgeid) | **PUT** /projects/{id}/badges/{badge_id} | Updates a badge of a project. *BatchedBackgroundMigrationsApi* | [**getApiV4AdminBatchedBackgroundMigrations**](docs/BatchedBackgroundMigrationsApi.md#getapiv4adminbatchedbackgroundmigrations) | **GET** /admin/batched_background_migrations | *BatchedBackgroundMigrationsApi* | [**getApiV4AdminBatchedBackgroundMigrationsId**](docs/BatchedBackgroundMigrationsApi.md#getapiv4adminbatchedbackgroundmigrationsid) | **GET** /admin/batched_background_migrations/{id} | *BatchedBackgroundMigrationsApi* | [**putApiV4AdminBatchedBackgroundMigrationsIdPause**](docs/BatchedBackgroundMigrationsApi.md#putapiv4adminbatchedbackgroundmigrationsidpause) | **PUT** /admin/batched_background_migrations/{id}/pause | *BatchedBackgroundMigrationsApi* | [**putApiV4AdminBatchedBackgroundMigrationsIdResume**](docs/BatchedBackgroundMigrationsApi.md#putapiv4adminbatchedbackgroundmigrationsidresume) | **PUT** /admin/batched_background_migrations/{id}/resume | *BranchesApi* | [**deleteApiV4ProjectsIdRepositoryBranchesBranch**](docs/BranchesApi.md#deleteapiv4projectsidrepositorybranchesbranch) | **DELETE** /projects/{id}/repository/branches/{branch} | *BranchesApi* | [**deleteApiV4ProjectsIdRepositoryMergedBranches**](docs/BranchesApi.md#deleteapiv4projectsidrepositorymergedbranches) | **DELETE** /projects/{id}/repository/merged_branches | *BranchesApi* | [**getApiV4ProjectsIdRepositoryBranches**](docs/BranchesApi.md#getapiv4projectsidrepositorybranches) | **GET** /projects/{id}/repository/branches | *BranchesApi* | [**getApiV4ProjectsIdRepositoryBranchesBranch**](docs/BranchesApi.md#getapiv4projectsidrepositorybranchesbranch) | **GET** /projects/{id}/repository/branches/{branch} | *BranchesApi* | [**headApiV4ProjectsIdRepositoryBranchesBranch**](docs/BranchesApi.md#headapiv4projectsidrepositorybranchesbranch) | **HEAD** /projects/{id}/repository/branches/{branch} | *BranchesApi* | [**postApiV4ProjectsIdRepositoryBranches**](docs/BranchesApi.md#postapiv4projectsidrepositorybranches) | **POST** /projects/{id}/repository/branches | *BranchesApi* | [**putApiV4ProjectsIdRepositoryBranchesBranchProtect**](docs/BranchesApi.md#putapiv4projectsidrepositorybranchesbranchprotect) | **PUT** /projects/{id}/repository/branches/{branch}/protect | *BranchesApi* | [**putApiV4ProjectsIdRepositoryBranchesBranchUnprotect**](docs/BranchesApi.md#putapiv4projectsidrepositorybranchesbranchunprotect) | **PUT** /projects/{id}/repository/branches/{branch}/unprotect | *BroadcastMessagesApi* | [**deleteApiV4BroadcastMessagesId**](docs/BroadcastMessagesApi.md#deleteapiv4broadcastmessagesid) | **DELETE** /broadcast_messages/{id} | Delete a broadcast message *BroadcastMessagesApi* | [**getApiV4BroadcastMessages**](docs/BroadcastMessagesApi.md#getapiv4broadcastmessages) | **GET** /broadcast_messages | Get all broadcast messages *BroadcastMessagesApi* | [**getApiV4BroadcastMessagesId**](docs/BroadcastMessagesApi.md#getapiv4broadcastmessagesid) | **GET** /broadcast_messages/{id} | Get a specific broadcast message *BroadcastMessagesApi* | [**postApiV4BroadcastMessages**](docs/BroadcastMessagesApi.md#postapiv4broadcastmessages) | **POST** /broadcast_messages | Create a broadcast message *BroadcastMessagesApi* | [**putApiV4BroadcastMessagesId**](docs/BroadcastMessagesApi.md#putapiv4broadcastmessagesid) | **PUT** /broadcast_messages/{id} | Update a broadcast message *BulkImportsApi* | [**getApiV4BulkImports**](docs/BulkImportsApi.md#getapiv4bulkimports) | **GET** /bulk_imports | List all GitLab Migrations *BulkImportsApi* | [**getApiV4BulkImportsEntities**](docs/BulkImportsApi.md#getapiv4bulkimportsentities) | **GET** /bulk_imports/entities | List all GitLab Migrations\' entities *BulkImportsApi* | [**getApiV4BulkImportsImportId**](docs/BulkImportsApi.md#getapiv4bulkimportsimportid) | **GET** /bulk_imports/{import_id} | Get GitLab Migration details *BulkImportsApi* | [**getApiV4BulkImportsImportIdEntities**](docs/BulkImportsApi.md#getapiv4bulkimportsimportidentities) | **GET** /bulk_imports/{import_id}/entities | List GitLab Migration entities *BulkImportsApi* | [**getApiV4BulkImportsImportIdEntitiesEntityId**](docs/BulkImportsApi.md#getapiv4bulkimportsimportidentitiesentityid) | **GET** /bulk_imports/{import_id}/entities/{entity_id} | Get GitLab Migration entity details *BulkImportsApi* | [**postApiV4BulkImports**](docs/BulkImportsApi.md#postapiv4bulkimports) | **POST** /bulk_imports | Start a new GitLab Migration *CiVariablesApi* | [**deleteApiV4AdminCiVariablesKey**](docs/CiVariablesApi.md#deleteapiv4admincivariableskey) | **DELETE** /admin/ci/variables/{key} | *CiVariablesApi* | [**getApiV4AdminCiVariables**](docs/CiVariablesApi.md#getapiv4admincivariables) | **GET** /admin/ci/variables | *CiVariablesApi* | [**getApiV4AdminCiVariablesKey**](docs/CiVariablesApi.md#getapiv4admincivariableskey) | **GET** /admin/ci/variables/{key} | *CiVariablesApi* | [**postApiV4AdminCiVariables**](docs/CiVariablesApi.md#postapiv4admincivariables) | **POST** /admin/ci/variables | *CiVariablesApi* | [**putApiV4AdminCiVariablesKey**](docs/CiVariablesApi.md#putapiv4admincivariableskey) | **PUT** /admin/ci/variables/{key} | *ClustersApi* | [**deleteApiV4AdminClustersClusterId**](docs/ClustersApi.md#deleteapiv4adminclustersclusterid) | **DELETE** /admin/clusters/{cluster_id} | Delete instance cluster *ClustersApi* | [**getApiV4AdminClusters**](docs/ClustersApi.md#getapiv4adminclusters) | **GET** /admin/clusters | List instance clusters *ClustersApi* | [**getApiV4AdminClustersClusterId**](docs/ClustersApi.md#getapiv4adminclustersclusterid) | **GET** /admin/clusters/{cluster_id} | Get a single instance cluster *ClustersApi* | [**postApiV4AdminClustersAdd**](docs/ClustersApi.md#postapiv4adminclustersadd) | **POST** /admin/clusters/add | Add existing instance cluster *ClustersApi* | [**putApiV4AdminClustersClusterId**](docs/ClustersApi.md#putapiv4adminclustersclusterid) | **PUT** /admin/clusters/{cluster_id} | Edit instance cluster *JobsApi* | [**getSingleJob**](docs/JobsApi.md#getsinglejob) | **GET** /projects/{id}/jobs/{job_id} | Get a single job by ID *JobsApi* | [**listProjectJobs**](docs/JobsApi.md#listprojectjobs) | **GET** /projects/{id}/jobs | List jobs for a project *JobsApi* | [**triggerManualJob**](docs/JobsApi.md#triggermanualjob) | **POST** /projects/{id}/jobs/{job_id}/play | Run a manual job *MetadataApi* | [**getApiV4Metadata**](docs/MetadataApi.md#getapiv4metadata) | **GET** /metadata | Retrieve metadata information for this GitLab instance *MetadataApi* | [**getApiV4Version**](docs/MetadataApi.md#getapiv4version) | **GET** /version | Retrieves version information for the GitLab instance *MigrationsApi* | [**postApiV4AdminMigrationsTimestampMark**](docs/MigrationsApi.md#postapiv4adminmigrationstimestampmark) | **POST** /admin/migrations/{timestamp}/mark | *PlanLimitsApi* | [**getApiV4ApplicationPlanLimits**](docs/PlanLimitsApi.md#getapiv4applicationplanlimits) | **GET** /application/plan_limits | Get current plan limits *PlanLimitsApi* | [**putApiV4ApplicationPlanLimits**](docs/PlanLimitsApi.md#putapiv4applicationplanlimits) | **PUT** /application/plan_limits | Change plan limits ### Documentation For Models - [APIEntitiesAccessRequester](docs/APIEntitiesAccessRequester.md) - [APIEntitiesAppearance](docs/APIEntitiesAppearance.md) - [APIEntitiesApplication](docs/APIEntitiesApplication.md) - [APIEntitiesApplicationWithSecret](docs/APIEntitiesApplicationWithSecret.md) - [APIEntitiesAvatar](docs/APIEntitiesAvatar.md) - [APIEntitiesBadge](docs/APIEntitiesBadge.md) - [APIEntitiesBasicBadgeDetails](docs/APIEntitiesBasicBadgeDetails.md) - [APIEntitiesBatchedBackgroundMigration](docs/APIEntitiesBatchedBackgroundMigration.md) - [APIEntitiesBranch](docs/APIEntitiesBranch.md) - [APIEntitiesBroadcastMessage](docs/APIEntitiesBroadcastMessage.md) - [APIEntitiesBulkImport](docs/APIEntitiesBulkImport.md) - [APIEntitiesBulkImports](docs/APIEntitiesBulkImports.md) - [APIEntitiesBulkImportsEntityFailure](docs/APIEntitiesBulkImportsEntityFailure.md) - [APIEntitiesCiVariable](docs/APIEntitiesCiVariable.md) - [APIEntitiesCluster](docs/APIEntitiesCluster.md) - [APIEntitiesCommit](docs/APIEntitiesCommit.md) - [APIEntitiesCustomAttribute](docs/APIEntitiesCustomAttribute.md) - [APIEntitiesDictionaryTable](docs/APIEntitiesDictionaryTable.md) - [APIEntitiesJob](docs/APIEntitiesJob.md) - [APIEntitiesJobProject](docs/APIEntitiesJobProject.md) - [APIEntitiesMetadata](docs/APIEntitiesMetadata.md) - [APIEntitiesMetadataKas](docs/APIEntitiesMetadataKas.md) - [APIEntitiesMetricImage](docs/APIEntitiesMetricImage.md) - [APIEntitiesPlanLimit](docs/APIEntitiesPlanLimit.md) - [APIEntitiesPlatformKubernetes](docs/APIEntitiesPlatformKubernetes.md) - [APIEntitiesProjectIdentity](docs/APIEntitiesProjectIdentity.md) - [APIEntitiesProviderGcp](docs/APIEntitiesProviderGcp.md) - [APIEntitiesUserBasic](docs/APIEntitiesUserBasic.md) - [DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter](docs/DeleteApiV4ProjectsIdRepositoryMergedBranchesIdParameter.md) - [PostApiV4AdminCiVariablesRequest](docs/PostApiV4AdminCiVariablesRequest.md) - [PostApiV4AdminClustersAddRequest](docs/PostApiV4AdminClustersAddRequest.md) - [PostApiV4ApplicationsRequest](docs/PostApiV4ApplicationsRequest.md) - [PostApiV4BroadcastMessagesRequest](docs/PostApiV4BroadcastMessagesRequest.md) - [PostApiV4GroupsIdBadgesRequest](docs/PostApiV4GroupsIdBadgesRequest.md) - [PutApiV4AdminBatchedBackgroundMigrationsIdResumeRequest](docs/PutApiV4AdminBatchedBackgroundMigrationsIdResumeRequest.md) - [PutApiV4AdminCiVariablesKeyRequest](docs/PutApiV4AdminCiVariablesKeyRequest.md) - [PutApiV4AdminClustersClusterIdRequest](docs/PutApiV4AdminClustersClusterIdRequest.md) - [PutApiV4ApplicationPlanLimitsRequest](docs/PutApiV4ApplicationPlanLimitsRequest.md) - [PutApiV4BroadcastMessagesIdRequest](docs/PutApiV4BroadcastMessagesIdRequest.md) - [PutApiV4GroupsIdAccessRequestsUserIdApproveRequest](docs/PutApiV4GroupsIdAccessRequestsUserIdApproveRequest.md) - [PutApiV4GroupsIdBadgesBadgeIdRequest](docs/PutApiV4GroupsIdBadgesBadgeIdRequest.md) - [PutApiV4ProjectsIdRepositoryBranchesBranchProtectRequest](docs/PutApiV4ProjectsIdRepositoryBranchesBranchProtectRequest.md) <a id="documentation-for-authorization"></a> ## Documentation For Authorization Authentication schemes defined for the API: <a id="ApiKeyAuth"></a> ### ApiKeyAuth - **Type**: API key - **API key parameter name**: Private-Token - **Location**: HTTP header