cberg
Version:
Node.js Client for the Codeberg API
1,340 lines (949 loc) • 151 kB
Markdown
# IssueApi
All URIs are relative to */api/v1*
|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**issueAddLabel**](#issueaddlabel) | **POST** /repos/{owner}/{repo}/issues/{index}/labels | Add a label to an issue|
|[**issueAddSubscription**](#issueaddsubscription) | **PUT** /repos/{owner}/{repo}/issues/{index}/subscriptions/{user} | Subscribe user to issue|
|[**issueAddTime**](#issueaddtime) | **POST** /repos/{owner}/{repo}/issues/{index}/times | Add tracked time to a issue|
|[**issueCheckSubscription**](#issuechecksubscription) | **GET** /repos/{owner}/{repo}/issues/{index}/subscriptions/check | Check if user is subscribed to an issue|
|[**issueClearLabels**](#issueclearlabels) | **DELETE** /repos/{owner}/{repo}/issues/{index}/labels | Remove all labels from an issue|
|[**issueCreateComment**](#issuecreatecomment) | **POST** /repos/{owner}/{repo}/issues/{index}/comments | Add a comment to an issue|
|[**issueCreateIssue**](#issuecreateissue) | **POST** /repos/{owner}/{repo}/issues | Create an issue. If using deadline only the date will be taken into account, and time of day ignored.|
|[**issueCreateIssueAttachment**](#issuecreateissueattachment) | **POST** /repos/{owner}/{repo}/issues/{index}/assets | Create an issue attachment|
|[**issueCreateIssueBlocking**](#issuecreateissueblocking) | **POST** /repos/{owner}/{repo}/issues/{index}/blocks | Block the issue given in the body by the issue in path|
|[**issueCreateIssueCommentAttachment**](#issuecreateissuecommentattachment) | **POST** /repos/{owner}/{repo}/issues/comments/{id}/assets | Create a comment attachment|
|[**issueCreateIssueDependencies**](#issuecreateissuedependencies) | **POST** /repos/{owner}/{repo}/issues/{index}/dependencies | Make the issue in the url depend on the issue in the form.|
|[**issueCreateLabel**](#issuecreatelabel) | **POST** /repos/{owner}/{repo}/labels | Create a label|
|[**issueCreateMilestone**](#issuecreatemilestone) | **POST** /repos/{owner}/{repo}/milestones | Create a milestone|
|[**issueDelete**](#issuedelete) | **DELETE** /repos/{owner}/{repo}/issues/{index} | Delete an issue|
|[**issueDeleteComment**](#issuedeletecomment) | **DELETE** /repos/{owner}/{repo}/issues/comments/{id} | Delete a comment|
|[**issueDeleteCommentDeprecated**](#issuedeletecommentdeprecated) | **DELETE** /repos/{owner}/{repo}/issues/{index}/comments/{id} | Delete a comment|
|[**issueDeleteCommentReaction**](#issuedeletecommentreaction) | **DELETE** /repos/{owner}/{repo}/issues/comments/{id}/reactions | Remove a reaction from a comment of an issue|
|[**issueDeleteIssueAttachment**](#issuedeleteissueattachment) | **DELETE** /repos/{owner}/{repo}/issues/{index}/assets/{attachment_id} | Delete an issue attachment|
|[**issueDeleteIssueCommentAttachment**](#issuedeleteissuecommentattachment) | **DELETE** /repos/{owner}/{repo}/issues/comments/{id}/assets/{attachment_id} | Delete a comment attachment|
|[**issueDeleteIssueReaction**](#issuedeleteissuereaction) | **DELETE** /repos/{owner}/{repo}/issues/{index}/reactions | Remove a reaction from an issue|
|[**issueDeleteLabel**](#issuedeletelabel) | **DELETE** /repos/{owner}/{repo}/labels/{id} | Delete a label|
|[**issueDeleteMilestone**](#issuedeletemilestone) | **DELETE** /repos/{owner}/{repo}/milestones/{id} | Delete a milestone|
|[**issueDeleteStopWatch**](#issuedeletestopwatch) | **DELETE** /repos/{owner}/{repo}/issues/{index}/stopwatch/delete | Delete an issue\'s existing stopwatch.|
|[**issueDeleteSubscription**](#issuedeletesubscription) | **DELETE** /repos/{owner}/{repo}/issues/{index}/subscriptions/{user} | Unsubscribe user from issue|
|[**issueDeleteTime**](#issuedeletetime) | **DELETE** /repos/{owner}/{repo}/issues/{index}/times/{id} | Delete specific tracked time|
|[**issueEditComment**](#issueeditcomment) | **PATCH** /repos/{owner}/{repo}/issues/comments/{id} | Edit a comment|
|[**issueEditCommentDeprecated**](#issueeditcommentdeprecated) | **PATCH** /repos/{owner}/{repo}/issues/{index}/comments/{id} | Edit a comment|
|[**issueEditIssue**](#issueeditissue) | **PATCH** /repos/{owner}/{repo}/issues/{index} | Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.|
|[**issueEditIssueAttachment**](#issueeditissueattachment) | **PATCH** /repos/{owner}/{repo}/issues/{index}/assets/{attachment_id} | Edit an issue attachment|
|[**issueEditIssueCommentAttachment**](#issueeditissuecommentattachment) | **PATCH** /repos/{owner}/{repo}/issues/comments/{id}/assets/{attachment_id} | Edit a comment attachment|
|[**issueEditIssueDeadline**](#issueeditissuedeadline) | **POST** /repos/{owner}/{repo}/issues/{index}/deadline | Set an issue deadline. If set to null, the deadline is deleted. If using deadline only the date will be taken into account, and time of day ignored.|
|[**issueEditLabel**](#issueeditlabel) | **PATCH** /repos/{owner}/{repo}/labels/{id} | Update a label|
|[**issueEditMilestone**](#issueeditmilestone) | **PATCH** /repos/{owner}/{repo}/milestones/{id} | Update a milestone|
|[**issueGetComment**](#issuegetcomment) | **GET** /repos/{owner}/{repo}/issues/comments/{id} | Get a comment|
|[**issueGetCommentReactions**](#issuegetcommentreactions) | **GET** /repos/{owner}/{repo}/issues/comments/{id}/reactions | Get a list of reactions from a comment of an issue|
|[**issueGetComments**](#issuegetcomments) | **GET** /repos/{owner}/{repo}/issues/{index}/comments | List all comments on an issue|
|[**issueGetCommentsAndTimeline**](#issuegetcommentsandtimeline) | **GET** /repos/{owner}/{repo}/issues/{index}/timeline | List all comments and events on an issue|
|[**issueGetIssue**](#issuegetissue) | **GET** /repos/{owner}/{repo}/issues/{index} | Get an issue|
|[**issueGetIssueAttachment**](#issuegetissueattachment) | **GET** /repos/{owner}/{repo}/issues/{index}/assets/{attachment_id} | Get an issue attachment|
|[**issueGetIssueCommentAttachment**](#issuegetissuecommentattachment) | **GET** /repos/{owner}/{repo}/issues/comments/{id}/assets/{attachment_id} | Get a comment attachment|
|[**issueGetIssueReactions**](#issuegetissuereactions) | **GET** /repos/{owner}/{repo}/issues/{index}/reactions | Get a list reactions of an issue|
|[**issueGetLabel**](#issuegetlabel) | **GET** /repos/{owner}/{repo}/labels/{id} | Get a single label|
|[**issueGetLabels**](#issuegetlabels) | **GET** /repos/{owner}/{repo}/issues/{index}/labels | Get an issue\'s labels|
|[**issueGetMilestone**](#issuegetmilestone) | **GET** /repos/{owner}/{repo}/milestones/{id} | Get a milestone|
|[**issueGetMilestonesList**](#issuegetmilestoneslist) | **GET** /repos/{owner}/{repo}/milestones | Get all of a repository\'s opened milestones|
|[**issueGetRepoComments**](#issuegetrepocomments) | **GET** /repos/{owner}/{repo}/issues/comments | List all comments in a repository|
|[**issueListBlocks**](#issuelistblocks) | **GET** /repos/{owner}/{repo}/issues/{index}/blocks | List issues that are blocked by this issue|
|[**issueListIssueAttachments**](#issuelistissueattachments) | **GET** /repos/{owner}/{repo}/issues/{index}/assets | List issue\'s attachments|
|[**issueListIssueCommentAttachments**](#issuelistissuecommentattachments) | **GET** /repos/{owner}/{repo}/issues/comments/{id}/assets | List comment\'s attachments|
|[**issueListIssueDependencies**](#issuelistissuedependencies) | **GET** /repos/{owner}/{repo}/issues/{index}/dependencies | List an issue\'s dependencies, i.e all issues that block this issue.|
|[**issueListIssues**](#issuelistissues) | **GET** /repos/{owner}/{repo}/issues | List a repository\'s issues|
|[**issueListLabels**](#issuelistlabels) | **GET** /repos/{owner}/{repo}/labels | Get all of a repository\'s labels|
|[**issuePostCommentReaction**](#issuepostcommentreaction) | **POST** /repos/{owner}/{repo}/issues/comments/{id}/reactions | Add a reaction to a comment of an issue|
|[**issuePostIssueReaction**](#issuepostissuereaction) | **POST** /repos/{owner}/{repo}/issues/{index}/reactions | Add a reaction to an issue|
|[**issueRemoveIssueBlocking**](#issueremoveissueblocking) | **DELETE** /repos/{owner}/{repo}/issues/{index}/blocks | Unblock the issue given in the body by the issue in path|
|[**issueRemoveIssueDependencies**](#issueremoveissuedependencies) | **DELETE** /repos/{owner}/{repo}/issues/{index}/dependencies | Remove an issue dependency|
|[**issueRemoveLabel**](#issueremovelabel) | **DELETE** /repos/{owner}/{repo}/issues/{index}/labels/{id} | Remove a label from an issue|
|[**issueReplaceLabels**](#issuereplacelabels) | **PUT** /repos/{owner}/{repo}/issues/{index}/labels | Replace an issue\'s labels|
|[**issueResetTime**](#issueresettime) | **DELETE** /repos/{owner}/{repo}/issues/{index}/times | Reset a tracked time of an issue|
|[**issueSearchIssues**](#issuesearchissues) | **GET** /repos/issues/search | Search for issues across the repositories that the user has access to|
|[**issueStartStopWatch**](#issuestartstopwatch) | **POST** /repos/{owner}/{repo}/issues/{index}/stopwatch/start | Start stopwatch on an issue.|
|[**issueStopStopWatch**](#issuestopstopwatch) | **POST** /repos/{owner}/{repo}/issues/{index}/stopwatch/stop | Stop an issue\'s existing stopwatch.|
|[**issueSubscriptions**](#issuesubscriptions) | **GET** /repos/{owner}/{repo}/issues/{index}/subscriptions | Get users who subscribed on an issue.|
|[**issueTrackedTimes**](#issuetrackedtimes) | **GET** /repos/{owner}/{repo}/issues/{index}/times | List an issue\'s tracked times|
|[**moveIssuePin**](#moveissuepin) | **PATCH** /repos/{owner}/{repo}/issues/{index}/pin/{position} | Moves the Pin to the given Position|
|[**pinIssue**](#pinissue) | **POST** /repos/{owner}/{repo}/issues/{index}/pin | Pin an Issue|
|[**unpinIssue**](#unpinissue) | **DELETE** /repos/{owner}/{repo}/issues/{index}/pin | Unpin an Issue|
# **issueAddLabel**
> Array<Label> issueAddLabel()
### Example
```typescript
import {
IssueApi,
Configuration,
IssueLabelsOption
} from 'berg';
const configuration = new Configuration();
const apiInstance = new IssueApi(configuration);
let owner: string; //owner of the repo (default to undefined)
let repo: string; //name of the repo (default to undefined)
let index: number; //index of the issue (default to undefined)
let body: IssueLabelsOption; // (optional)
const { status, data } = await apiInstance.issueAddLabel(
owner,
repo,
index,
body
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **body** | **IssueLabelsOption**| | |
| **owner** | [**string**] | owner of the repo | defaults to undefined|
| **repo** | [**string**] | name of the repo | defaults to undefined|
| **index** | [**number**] | index of the issue | defaults to undefined|
### Return type
**Array<Label>**
### Authorization
[TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | LabelList | - |
|**403** | APIForbiddenError is a forbidden error response | - |
|**404** | APINotFound is a not found error response | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **issueAddSubscription**
> issueAddSubscription()
### Example
```typescript
import {
IssueApi,
Configuration
} from 'berg';
const configuration = new Configuration();
const apiInstance = new IssueApi(configuration);
let owner: string; //owner of the repo (default to undefined)
let repo: string; //name of the repo (default to undefined)
let index: number; //index of the issue (default to undefined)
let user: string; //user to subscribe (default to undefined)
const { status, data } = await apiInstance.issueAddSubscription(
owner,
repo,
index,
user
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **owner** | [**string**] | owner of the repo | defaults to undefined|
| **repo** | [**string**] | name of the repo | defaults to undefined|
| **index** | [**number**] | index of the issue | defaults to undefined|
| **user** | [**string**] | user to subscribe | defaults to undefined|
### Return type
void (empty response body)
### Authorization
[TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Already subscribed | - |
|**201** | Successfully Subscribed | - |
|**304** | User can only subscribe itself if he is no admin | - |
|**404** | APINotFound is a not found error response | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **issueAddTime**
> TrackedTime issueAddTime()
### Example
```typescript
import {
IssueApi,
Configuration,
AddTimeOption
} from 'berg';
const configuration = new Configuration();
const apiInstance = new IssueApi(configuration);
let owner: string; //owner of the repo (default to undefined)
let repo: string; //name of the repo (default to undefined)
let index: number; //index of the issue (default to undefined)
let body: AddTimeOption; // (optional)
const { status, data } = await apiInstance.issueAddTime(
owner,
repo,
index,
body
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **body** | **AddTimeOption**| | |
| **owner** | [**string**] | owner of the repo | defaults to undefined|
| **repo** | [**string**] | name of the repo | defaults to undefined|
| **index** | [**number**] | index of the issue | defaults to undefined|
### Return type
**TrackedTime**
### Authorization
[TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | TrackedTime | - |
|**400** | APIError is error format response | - |
|**403** | APIForbiddenError is a forbidden error response | - |
|**404** | APINotFound is a not found error response | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **issueCheckSubscription**
> WatchInfo issueCheckSubscription()
### Example
```typescript
import {
IssueApi,
Configuration
} from 'berg';
const configuration = new Configuration();
const apiInstance = new IssueApi(configuration);
let owner: string; //owner of the repo (default to undefined)
let repo: string; //name of the repo (default to undefined)
let index: number; //index of the issue (default to undefined)
const { status, data } = await apiInstance.issueCheckSubscription(
owner,
repo,
index
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **owner** | [**string**] | owner of the repo | defaults to undefined|
| **repo** | [**string**] | name of the repo | defaults to undefined|
| **index** | [**number**] | index of the issue | defaults to undefined|
### Return type
**WatchInfo**
### Authorization
[TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | WatchInfo | - |
|**404** | APINotFound is a not found error response | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **issueClearLabels**
> issueClearLabels()
### Example
```typescript
import {
IssueApi,
Configuration,
DeleteLabelsOption
} from 'berg';
const configuration = new Configuration();
const apiInstance = new IssueApi(configuration);
let owner: string; //owner of the repo (default to undefined)
let repo: string; //name of the repo (default to undefined)
let index: number; //index of the issue (default to undefined)
let body: DeleteLabelsOption; // (optional)
const { status, data } = await apiInstance.issueClearLabels(
owner,
repo,
index,
body
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **body** | **DeleteLabelsOption**| | |
| **owner** | [**string**] | owner of the repo | defaults to undefined|
| **repo** | [**string**] | name of the repo | defaults to undefined|
| **index** | [**number**] | index of the issue | defaults to undefined|
### Return type
void (empty response body)
### Authorization
[TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)
### HTTP request headers
- **Content-Type**: application/json, text/plain
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**204** | APIEmpty is an empty response | - |
|**403** | APIForbiddenError is a forbidden error response | - |
|**404** | APINotFound is a not found error response | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **issueCreateComment**
> Comment issueCreateComment()
### Example
```typescript
import {
IssueApi,
Configuration,
CreateIssueCommentOption
} from 'berg';
const configuration = new Configuration();
const apiInstance = new IssueApi(configuration);
let owner: string; //owner of the repo (default to undefined)
let repo: string; //name of the repo (default to undefined)
let index: number; //index of the issue (default to undefined)
let body: CreateIssueCommentOption; // (optional)
const { status, data } = await apiInstance.issueCreateComment(
owner,
repo,
index,
body
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **body** | **CreateIssueCommentOption**| | |
| **owner** | [**string**] | owner of the repo | defaults to undefined|
| **repo** | [**string**] | name of the repo | defaults to undefined|
| **index** | [**number**] | index of the issue | defaults to undefined|
### Return type
**Comment**
### Authorization
[TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**201** | Comment | - |
|**403** | APIForbiddenError is a forbidden error response | - |
|**404** | APINotFound is a not found error response | - |
|**423** | APIRepoArchivedError is an error that is raised when an archived repo should be modified | - |
|**500** | APIInternalServerError is an error that is raised when an internal server error occurs | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **issueCreateIssue**
> Issue issueCreateIssue()
### Example
```typescript
import {
IssueApi,
Configuration,
CreateIssueOption
} from 'berg';
const configuration = new Configuration();
const apiInstance = new IssueApi(configuration);
let owner: string; //owner of the repo (default to undefined)
let repo: string; //name of the repo (default to undefined)
let body: CreateIssueOption; // (optional)
const { status, data } = await apiInstance.issueCreateIssue(
owner,
repo,
body
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **body** | **CreateIssueOption**| | |
| **owner** | [**string**] | owner of the repo | defaults to undefined|
| **repo** | [**string**] | name of the repo | defaults to undefined|
### Return type
**Issue**
### Authorization
[TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**201** | Issue | - |
|**403** | APIForbiddenError is a forbidden error response | - |
|**404** | APINotFound is a not found error response | - |
|**412** | APIError is error format response | - |
|**422** | APIValidationError is error format response related to input validation | - |
|**423** | APIRepoArchivedError is an error that is raised when an archived repo should be modified | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **issueCreateIssueAttachment**
> Attachment issueCreateIssueAttachment()
### Example
```typescript
import {
IssueApi,
Configuration
} from 'berg';
const configuration = new Configuration();
const apiInstance = new IssueApi(configuration);
let owner: string; //owner of the repo (default to undefined)
let repo: string; //name of the repo (default to undefined)
let index: number; //index of the issue (default to undefined)
let attachment: File; //attachment to upload (default to undefined)
let name: string; //name of the attachment (optional) (default to undefined)
let updatedAt: string; //time of the attachment\'s creation. This is a timestamp in RFC 3339 format (optional) (default to undefined)
const { status, data } = await apiInstance.issueCreateIssueAttachment(
owner,
repo,
index,
attachment,
name,
updatedAt
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **owner** | [**string**] | owner of the repo | defaults to undefined|
| **repo** | [**string**] | name of the repo | defaults to undefined|
| **index** | [**number**] | index of the issue | defaults to undefined|
| **attachment** | [**File**] | attachment to upload | defaults to undefined|
| **name** | [**string**] | name of the attachment | (optional) defaults to undefined|
| **updatedAt** | [**string**] | time of the attachment\'s creation. This is a timestamp in RFC 3339 format | (optional) defaults to undefined|
### Return type
**Attachment**
### Authorization
[TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**201** | Attachment | - |
|**400** | APIError is error format response | - |
|**404** | APIError is error format response | - |
|**413** | QuotaExceeded | * user_id - <br> * message - <br> * username - <br> |
|**422** | APIValidationError is error format response related to input validation | - |
|**423** | APIRepoArchivedError is an error that is raised when an archived repo should be modified | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **issueCreateIssueBlocking**
> Issue issueCreateIssueBlocking()
### Example
```typescript
import {
IssueApi,
Configuration,
IssueMeta
} from 'berg';
const configuration = new Configuration();
const apiInstance = new IssueApi(configuration);
let owner: string; //owner of the repo (default to undefined)
let repo: string; //name of the repo (default to undefined)
let index: string; //index of the issue (default to undefined)
let body: IssueMeta; // (optional)
const { status, data } = await apiInstance.issueCreateIssueBlocking(
owner,
repo,
index,
body
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **body** | **IssueMeta**| | |
| **owner** | [**string**] | owner of the repo | defaults to undefined|
| **repo** | [**string**] | name of the repo | defaults to undefined|
| **index** | [**string**] | index of the issue | defaults to undefined|
### Return type
**Issue**
### Authorization
[TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)
### HTTP request headers
- **Content-Type**: application/json, text/plain
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**201** | Issue | - |
|**404** | the issue does not exist | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **issueCreateIssueCommentAttachment**
> Attachment issueCreateIssueCommentAttachment()
### Example
```typescript
import {
IssueApi,
Configuration
} from 'berg';
const configuration = new Configuration();
const apiInstance = new IssueApi(configuration);
let owner: string; //owner of the repo (default to undefined)
let repo: string; //name of the repo (default to undefined)
let id: number; //id of the comment (default to undefined)
let attachment: File; //attachment to upload (default to undefined)
let name: string; //name of the attachment (optional) (default to undefined)
let updatedAt: string; //time of the attachment\'s creation. This is a timestamp in RFC 3339 format (optional) (default to undefined)
const { status, data } = await apiInstance.issueCreateIssueCommentAttachment(
owner,
repo,
id,
attachment,
name,
updatedAt
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **owner** | [**string**] | owner of the repo | defaults to undefined|
| **repo** | [**string**] | name of the repo | defaults to undefined|
| **id** | [**number**] | id of the comment | defaults to undefined|
| **attachment** | [**File**] | attachment to upload | defaults to undefined|
| **name** | [**string**] | name of the attachment | (optional) defaults to undefined|
| **updatedAt** | [**string**] | time of the attachment\'s creation. This is a timestamp in RFC 3339 format | (optional) defaults to undefined|
### Return type
**Attachment**
### Authorization
[TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**201** | Attachment | - |
|**400** | APIError is error format response | - |
|**404** | APIError is error format response | - |
|**413** | QuotaExceeded | * user_id - <br> * message - <br> * username - <br> |
|**422** | APIValidationError is error format response related to input validation | - |
|**423** | APIRepoArchivedError is an error that is raised when an archived repo should be modified | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **issueCreateIssueDependencies**
> Issue issueCreateIssueDependencies()
### Example
```typescript
import {
IssueApi,
Configuration,
IssueMeta
} from 'berg';
const configuration = new Configuration();
const apiInstance = new IssueApi(configuration);
let owner: string; //owner of the repo (default to undefined)
let repo: string; //name of the repo (default to undefined)
let index: string; //index of the issue (default to undefined)
let body: IssueMeta; // (optional)
const { status, data } = await apiInstance.issueCreateIssueDependencies(
owner,
repo,
index,
body
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **body** | **IssueMeta**| | |
| **owner** | [**string**] | owner of the repo | defaults to undefined|
| **repo** | [**string**] | name of the repo | defaults to undefined|
| **index** | [**string**] | index of the issue | defaults to undefined|
### Return type
**Issue**
### Authorization
[TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)
### HTTP request headers
- **Content-Type**: application/json, text/plain
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**201** | Issue | - |
|**404** | the issue does not exist | - |
|**423** | APIRepoArchivedError is an error that is raised when an archived repo should be modified | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **issueCreateLabel**
> Label issueCreateLabel()
### Example
```typescript
import {
IssueApi,
Configuration,
CreateLabelOption
} from 'berg';
const configuration = new Configuration();
const apiInstance = new IssueApi(configuration);
let owner: string; //owner of the repo (default to undefined)
let repo: string; //name of the repo (default to undefined)
let body: CreateLabelOption; // (optional)
const { status, data } = await apiInstance.issueCreateLabel(
owner,
repo,
body
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **body** | **CreateLabelOption**| | |
| **owner** | [**string**] | owner of the repo | defaults to undefined|
| **repo** | [**string**] | name of the repo | defaults to undefined|
### Return type
**Label**
### Authorization
[TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**201** | Label | - |
|**404** | APINotFound is a not found error response | - |
|**422** | APIValidationError is error format response related to input validation | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **issueCreateMilestone**
> Milestone issueCreateMilestone()
### Example
```typescript
import {
IssueApi,
Configuration,
CreateMilestoneOption
} from 'berg';
const configuration = new Configuration();
const apiInstance = new IssueApi(configuration);
let owner: string; //owner of the repo (default to undefined)
let repo: string; //name of the repo (default to undefined)
let body: CreateMilestoneOption; // (optional)
const { status, data } = await apiInstance.issueCreateMilestone(
owner,
repo,
body
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **body** | **CreateMilestoneOption**| | |
| **owner** | [**string**] | owner of the repo | defaults to undefined|
| **repo** | [**string**] | name of the repo | defaults to undefined|
### Return type
**Milestone**
### Authorization
[TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**201** | Milestone | - |
|**404** | APINotFound is a not found error response | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **issueDelete**
> issueDelete()
### Example
```typescript
import {
IssueApi,
Configuration
} from 'berg';
const configuration = new Configuration();
const apiInstance = new IssueApi(configuration);
let owner: string; //owner of the repo (default to undefined)
let repo: string; //name of the repo (default to undefined)
let index: number; //index of issue to delete (default to undefined)
const { status, data } = await apiInstance.issueDelete(
owner,
repo,
index
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **owner** | [**string**] | owner of the repo | defaults to undefined|
| **repo** | [**string**] | name of the repo | defaults to undefined|
| **index** | [**number**] | index of issue to delete | defaults to undefined|
### Return type
void (empty response body)
### Authorization
[TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/html
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**204** | APIEmpty is an empty response | - |
|**403** | APIForbiddenError is a forbidden error response | - |
|**404** | APINotFound is a not found error response | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **issueDeleteComment**
> issueDeleteComment()
### Example
```typescript
import {
IssueApi,
Configuration
} from 'berg';
const configuration = new Configuration();
const apiInstance = new IssueApi(configuration);
let owner: string; //owner of the repo (default to undefined)
let repo: string; //name of the repo (default to undefined)
let id: number; //id of comment to delete (default to undefined)
const { status, data } = await apiInstance.issueDeleteComment(
owner,
repo,
id
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **owner** | [**string**] | owner of the repo | defaults to undefined|
| **repo** | [**string**] | name of the repo | defaults to undefined|
| **id** | [**number**] | id of comment to delete | defaults to undefined|
### Return type
void (empty response body)
### Authorization
[TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/html
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**204** | APIEmpty is an empty response | - |
|**403** | APIForbiddenError is a forbidden error response | - |
|**500** | APIInternalServerError is an error that is raised when an internal server error occurs | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **issueDeleteCommentDeprecated**
> issueDeleteCommentDeprecated()
### Example
```typescript
import {
IssueApi,
Configuration
} from 'berg';
const configuration = new Configuration();
const apiInstance = new IssueApi(configuration);
let owner: string; //owner of the repo (default to undefined)
let repo: string; //name of the repo (default to undefined)
let index: number; //this parameter is ignored (default to undefined)
let id: number; //id of comment to delete (default to undefined)
const { status, data } = await apiInstance.issueDeleteCommentDeprecated(
owner,
repo,
index,
id
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **owner** | [**string**] | owner of the repo | defaults to undefined|
| **repo** | [**string**] | name of the repo | defaults to undefined|
| **index** | [**number**] | this parameter is ignored | defaults to undefined|
| **id** | [**number**] | id of comment to delete | defaults to undefined|
### Return type
void (empty response body)
### Authorization
[TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/html
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**204** | APIEmpty is an empty response | - |
|**403** | APIForbiddenError is a forbidden error response | - |
|**500** | APIInternalServerError is an error that is raised when an internal server error occurs | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **issueDeleteCommentReaction**
> issueDeleteCommentReaction()
### Example
```typescript
import {
IssueApi,
Configuration,
EditReactionOption
} from 'berg';
const configuration = new Configuration();
const apiInstance = new IssueApi(configuration);
let owner: string; //owner of the repo (default to undefined)
let repo: string; //name of the repo (default to undefined)
let id: number; //id of the comment to edit (default to undefined)
let content: EditReactionOption; // (optional)
const { status, data } = await apiInstance.issueDeleteCommentReaction(
owner,
repo,
id,
content
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **content** | **EditReactionOption**| | |
| **owner** | [**string**] | owner of the repo | defaults to undefined|
| **repo** | [**string**] | name of the repo | defaults to undefined|
| **id** | [**number**] | id of the comment to edit | defaults to undefined|
### Return type
void (empty response body)
### Authorization
[TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | APIEmpty is an empty response | - |
|**403** | APIForbiddenError is a forbidden error response | - |
|**404** | APINotFound is a not found error response | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **issueDeleteIssueAttachment**
> issueDeleteIssueAttachment()
### Example
```typescript
import {
IssueApi,
Configuration
} from 'berg';
const configuration = new Configuration();
const apiInstance = new IssueApi(configuration);
let owner: string; //owner of the repo (default to undefined)
let repo: string; //name of the repo (default to undefined)
let index: number; //index of the issue (default to undefined)
let attachmentId: number; //id of the attachment to delete (default to undefined)
const { status, data } = await apiInstance.issueDeleteIssueAttachment(
owner,
repo,
index,
attachmentId
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **owner** | [**string**] | owner of the repo | defaults to undefined|
| **repo** | [**string**] | name of the repo | defaults to undefined|
| **index** | [**number**] | index of the issue | defaults to undefined|
| **attachmentId** | [**number**] | id of the attachment to delete | defaults to undefined|
### Return type
void (empty response body)
### Authorization
[TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**204** | APIEmpty is an empty response | - |
|**404** | APIError is error format response | - |
|**423** | APIRepoArchivedError is an error that is raised when an archived repo should be modified | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **issueDeleteIssueCommentAttachment**
> issueDeleteIssueCommentAttachment()
### Example
```typescript
import {
IssueApi,
Configuration
} from 'berg';
const configuration = new Configuration();
const apiInstance = new IssueApi(configuration);
let owner: string; //owner of the repo (default to undefined)
let repo: string; //name of the repo (default to undefined)
let id: number; //id of the comment (default to undefined)
let attachmentId: number; //id of the attachment to delete (default to undefined)
const { status, data } = await apiInstance.issueDeleteIssueCommentAttachment(
owner,
repo,
id,
attachmentId
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **owner** | [**string**] | owner of the repo | defaults to undefined|
| **repo** | [**string**] | name of the repo | defaults to undefined|
| **id** | [**number**] | id of the comment | defaults to undefined|
| **attachmentId** | [**number**] | id of the attachment to delete | defaults to undefined|
### Return type
void (empty response body)
### Authorization
[TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**204** | APIEmpty is an empty response | - |
|**404** | APIError is error format response | - |
|**423** | APIRepoArchivedError is an error that is raised when an archived repo should be modified | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **issueDeleteIssueReaction**
> issueDeleteIssueReaction()
### Example
```typescript
import {
IssueApi,
Configuration,
EditReactionOption
} from 'berg';
const configuration = new Configuration();
const apiInstance = new IssueApi(configuration);
let owner: string; //owner of the repo (default to undefined)
let repo: string; //name of the repo (default to undefined)
let index: number; //index of the issue (default to undefined)
let content: EditReactionOption; // (optional)
const { status, data } = await apiInstance.issueDeleteIssueReaction(
owner,
repo,
index,
content
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **content** | **EditReactionOption**| | |
| **owner** | [**string**] | owner of the repo | defaults to undefined|
| **repo** | [**string**] | name of the repo | defaults to undefined|
| **index** | [**number**] | index of the issue | defaults to undefined|
### Return type
void (empty response body)
### Authorization
[TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | APIEmpty is an empty response | - |
|**403** | APIForbiddenError is a forbidden error response | - |
|**404** | APINotFound is a not found error response | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **issueDeleteLabel**
> issueDeleteLabel()
### Example
```typescript
import {
IssueApi,
Configuration
} from 'berg';
const configuration = new Configuration();
const apiInstance = new IssueApi(configuration);
let owner: string; //owner of the repo (default to undefined)
let repo: string; //name of the repo (default to undefined)
let id: number; //id of the label to delete (default to undefined)
const { status, data } = await apiInstance.issueDeleteLabel(
owner,
repo,
id
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **owner