cberg
Version:
Node.js Client for the Codeberg API
1,525 lines (1,023 loc) • 118 kB
Markdown
# OrganizationApi
All URIs are relative to */api/v1*
|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**createOrgRepo**](#createorgrepo) | **POST** /orgs/{org}/repos | Create a repository in an organization|
|[**createOrgRepoDeprecated**](#createorgrepodeprecated) | **POST** /org/{org}/repos | Create a repository in an organization|
|[**createOrgVariable**](#createorgvariable) | **POST** /orgs/{org}/actions/variables/{variablename} | Create an org-level variable|
|[**deleteOrgSecret**](#deleteorgsecret) | **DELETE** /orgs/{org}/actions/secrets/{secretname} | Delete a secret in an organization|
|[**deleteOrgVariable**](#deleteorgvariable) | **DELETE** /orgs/{org}/actions/variables/{variablename} | Delete an org-level variable|
|[**getOrgVariable**](#getorgvariable) | **GET** /orgs/{org}/actions/variables/{variablename} | Get an org-level variable|
|[**getOrgVariablesList**](#getorgvariableslist) | **GET** /orgs/{org}/actions/variables | Get an org-level variables list|
|[**orgAddTeamMember**](#orgaddteammember) | **PUT** /teams/{id}/members/{username} | Add a team member|
|[**orgAddTeamRepository**](#orgaddteamrepository) | **PUT** /teams/{id}/repos/{org}/{repo} | Add a repository to a team|
|[**orgBlockUser**](#orgblockuser) | **PUT** /orgs/{org}/block/{username} | Blocks a user from the organization|
|[**orgCheckQuota**](#orgcheckquota) | **GET** /orgs/{org}/quota/check | Check if the organization is over quota for a given subject|
|[**orgConcealMember**](#orgconcealmember) | **DELETE** /orgs/{org}/public_members/{username} | Conceal a user\'s membership|
|[**orgCreate**](#orgcreate) | **POST** /orgs | Create an organization|
|[**orgCreateHook**](#orgcreatehook) | **POST** /orgs/{org}/hooks | Create a hook|
|[**orgCreateLabel**](#orgcreatelabel) | **POST** /orgs/{org}/labels | Create a label for an organization|
|[**orgCreateTeam**](#orgcreateteam) | **POST** /orgs/{org}/teams | Create a team|
|[**orgDelete**](#orgdelete) | **DELETE** /orgs/{org} | Delete an organization|
|[**orgDeleteAvatar**](#orgdeleteavatar) | **DELETE** /orgs/{org}/avatar | Delete Avatar|
|[**orgDeleteHook**](#orgdeletehook) | **DELETE** /orgs/{org}/hooks/{id} | Delete a hook|
|[**orgDeleteLabel**](#orgdeletelabel) | **DELETE** /orgs/{org}/labels/{id} | Delete a label|
|[**orgDeleteMember**](#orgdeletemember) | **DELETE** /orgs/{org}/members/{username} | Remove a member from an organization|
|[**orgDeleteTeam**](#orgdeleteteam) | **DELETE** /teams/{id} | Delete a team|
|[**orgEdit**](#orgedit) | **PATCH** /orgs/{org} | Edit an organization|
|[**orgEditHook**](#orgedithook) | **PATCH** /orgs/{org}/hooks/{id} | Update a hook|
|[**orgEditLabel**](#orgeditlabel) | **PATCH** /orgs/{org}/labels/{id} | Update a label|
|[**orgEditTeam**](#orgeditteam) | **PATCH** /teams/{id} | Edit a team|
|[**orgGet**](#orgget) | **GET** /orgs/{org} | Get an organization|
|[**orgGetAll**](#orggetall) | **GET** /orgs | Get list of organizations|
|[**orgGetHook**](#orggethook) | **GET** /orgs/{org}/hooks/{id} | Get a hook|
|[**orgGetLabel**](#orggetlabel) | **GET** /orgs/{org}/labels/{id} | Get a single label|
|[**orgGetQuota**](#orggetquota) | **GET** /orgs/{org}/quota | Get quota information for an organization|
|[**orgGetRunnerRegistrationToken**](#orggetrunnerregistrationtoken) | **GET** /orgs/{org}/actions/runners/registration-token | Get an organization\'s actions runner registration token|
|[**orgGetTeam**](#orggetteam) | **GET** /teams/{id} | Get a team|
|[**orgGetUserPermissions**](#orggetuserpermissions) | **GET** /users/{username}/orgs/{org}/permissions | Get user permissions in organization|
|[**orgIsMember**](#orgismember) | **GET** /orgs/{org}/members/{username} | Check if a user is a member of an organization|
|[**orgIsPublicMember**](#orgispublicmember) | **GET** /orgs/{org}/public_members/{username} | Check if a user is a public member of an organization|
|[**orgListActionsSecrets**](#orglistactionssecrets) | **GET** /orgs/{org}/actions/secrets | List an organization\'s actions secrets|
|[**orgListActivityFeeds**](#orglistactivityfeeds) | **GET** /orgs/{org}/activities/feeds | List an organization\'s activity feeds|
|[**orgListBlockedUsers**](#orglistblockedusers) | **GET** /orgs/{org}/list_blocked | List the organization\'s blocked users|
|[**orgListCurrentUserOrgs**](#orglistcurrentuserorgs) | **GET** /user/orgs | List the current user\'s organizations|
|[**orgListHooks**](#orglisthooks) | **GET** /orgs/{org}/hooks | List an organization\'s webhooks|
|[**orgListLabels**](#orglistlabels) | **GET** /orgs/{org}/labels | List an organization\'s labels|
|[**orgListMembers**](#orglistmembers) | **GET** /orgs/{org}/members | List an organization\'s members|
|[**orgListPublicMembers**](#orglistpublicmembers) | **GET** /orgs/{org}/public_members | List an organization\'s public members|
|[**orgListQuotaArtifacts**](#orglistquotaartifacts) | **GET** /orgs/{org}/quota/artifacts | List the artifacts affecting the organization\'s quota|
|[**orgListQuotaAttachments**](#orglistquotaattachments) | **GET** /orgs/{org}/quota/attachments | List the attachments affecting the organization\'s quota|
|[**orgListQuotaPackages**](#orglistquotapackages) | **GET** /orgs/{org}/quota/packages | List the packages affecting the organization\'s quota|
|[**orgListRepos**](#orglistrepos) | **GET** /orgs/{org}/repos | List an organization\'s repos|
|[**orgListTeamActivityFeeds**](#orglistteamactivityfeeds) | **GET** /teams/{id}/activities/feeds | List a team\'s activity feeds|
|[**orgListTeamMember**](#orglistteammember) | **GET** /teams/{id}/members/{username} | List a particular member of team|
|[**orgListTeamMembers**](#orglistteammembers) | **GET** /teams/{id}/members | List a team\'s members|
|[**orgListTeamRepo**](#orglistteamrepo) | **GET** /teams/{id}/repos/{org}/{repo} | List a particular repo of team|
|[**orgListTeamRepos**](#orglistteamrepos) | **GET** /teams/{id}/repos | List a team\'s repos|
|[**orgListTeams**](#orglistteams) | **GET** /orgs/{org}/teams | List an organization\'s teams|
|[**orgListUserOrgs**](#orglistuserorgs) | **GET** /users/{username}/orgs | List a user\'s organizations|
|[**orgPublicizeMember**](#orgpublicizemember) | **PUT** /orgs/{org}/public_members/{username} | Publicize a user\'s membership|
|[**orgRemoveTeamMember**](#orgremoveteammember) | **DELETE** /teams/{id}/members/{username} | Remove a team member|
|[**orgRemoveTeamRepository**](#orgremoveteamrepository) | **DELETE** /teams/{id}/repos/{org}/{repo} | Remove a repository from a team|
|[**orgSearchRunJobs**](#orgsearchrunjobs) | **GET** /orgs/{org}/actions/runners/jobs | Search for organization\'s action jobs according filter conditions|
|[**orgUnblockUser**](#orgunblockuser) | **PUT** /orgs/{org}/unblock/{username} | Unblock a user from the organization|
|[**orgUpdateAvatar**](#orgupdateavatar) | **POST** /orgs/{org}/avatar | Update Avatar|
|[**renameOrg**](#renameorg) | **POST** /orgs/{org}/rename | Rename an organization|
|[**teamSearch**](#teamsearch) | **GET** /orgs/{org}/teams/search | Search for teams within an organization|
|[**updateOrgSecret**](#updateorgsecret) | **PUT** /orgs/{org}/actions/secrets/{secretname} | Create or Update a secret value in an organization|
|[**updateOrgVariable**](#updateorgvariable) | **PUT** /orgs/{org}/actions/variables/{variablename} | Update an org-level variable|
# **createOrgRepo**
> Repository createOrgRepo()
### Example
```typescript
import {
OrganizationApi,
Configuration,
CreateRepoOption
} from 'berg';
const configuration = new Configuration();
const apiInstance = new OrganizationApi(configuration);
let org: string; //name of organization (default to undefined)
let body: CreateRepoOption; // (optional)
const { status, data } = await apiInstance.createOrgRepo(
org,
body
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **body** | **CreateRepoOption**| | |
| **org** | [**string**] | name of organization | defaults to undefined|
### Return type
**Repository**
### 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** | Repository | - |
|**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)
# **createOrgRepoDeprecated**
> Repository createOrgRepoDeprecated()
### Example
```typescript
import {
OrganizationApi,
Configuration,
CreateRepoOption
} from 'berg';
const configuration = new Configuration();
const apiInstance = new OrganizationApi(configuration);
let org: string; //name of organization (default to undefined)
let body: CreateRepoOption; // (optional)
const { status, data } = await apiInstance.createOrgRepoDeprecated(
org,
body
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **body** | **CreateRepoOption**| | |
| **org** | [**string**] | name of organization | defaults to undefined|
### Return type
**Repository**
### 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** | Repository | - |
|**403** | APIForbiddenError is a forbidden error response | - |
|**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)
# **createOrgVariable**
> createOrgVariable()
### Example
```typescript
import {
OrganizationApi,
Configuration,
CreateVariableOption
} from 'berg';
const configuration = new Configuration();
const apiInstance = new OrganizationApi(configuration);
let org: string; //name of the organization (default to undefined)
let variablename: string; //name of the variable (default to undefined)
let body: CreateVariableOption; // (optional)
const { status, data } = await apiInstance.createOrgVariable(
org,
variablename,
body
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **body** | **CreateVariableOption**| | |
| **org** | [**string**] | name of the organization | defaults to undefined|
| **variablename** | [**string**] | name of the variable | 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 |
|-------------|-------------|------------------|
|**201** | response when creating an org-level variable | - |
|**204** | response when creating an org-level variable | - |
|**400** | APIError is error format 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)
# **deleteOrgSecret**
> deleteOrgSecret()
### Example
```typescript
import {
OrganizationApi,
Configuration
} from 'berg';
const configuration = new Configuration();
const apiInstance = new OrganizationApi(configuration);
let org: string; //name of organization (default to undefined)
let secretname: string; //name of the secret (default to undefined)
const { status, data } = await apiInstance.deleteOrgSecret(
org,
secretname
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **org** | [**string**] | name of organization | defaults to undefined|
| **secretname** | [**string**] | name of the secret | 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** | delete one secret of the organization | - |
|**400** | APIError is error format 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)
# **deleteOrgVariable**
> ActionVariable deleteOrgVariable()
### Example
```typescript
import {
OrganizationApi,
Configuration
} from 'berg';
const configuration = new Configuration();
const apiInstance = new OrganizationApi(configuration);
let org: string; //name of the organization (default to undefined)
let variablename: string; //name of the variable (default to undefined)
const { status, data } = await apiInstance.deleteOrgVariable(
org,
variablename
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **org** | [**string**] | name of the organization | defaults to undefined|
| **variablename** | [**string**] | name of the variable | defaults to undefined|
### Return type
**ActionVariable**
### 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** | ActionVariable | - |
|**201** | response when deleting a variable | - |
|**204** | response when deleting a variable | - |
|**400** | APIError is error format 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)
# **getOrgVariable**
> ActionVariable getOrgVariable()
### Example
```typescript
import {
OrganizationApi,
Configuration
} from 'berg';
const configuration = new Configuration();
const apiInstance = new OrganizationApi(configuration);
let org: string; //name of the organization (default to undefined)
let variablename: string; //name of the variable (default to undefined)
const { status, data } = await apiInstance.getOrgVariable(
org,
variablename
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **org** | [**string**] | name of the organization | defaults to undefined|
| **variablename** | [**string**] | name of the variable | defaults to undefined|
### Return type
**ActionVariable**
### 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** | ActionVariable | - |
|**400** | APIError is error format 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)
# **getOrgVariablesList**
> Array<ActionVariable> getOrgVariablesList()
### Example
```typescript
import {
OrganizationApi,
Configuration
} from 'berg';
const configuration = new Configuration();
const apiInstance = new OrganizationApi(configuration);
let org: string; //name of the organization (default to undefined)
let page: number; //page number of results to return (1-based) (optional) (default to undefined)
let limit: number; //page size of results (optional) (default to undefined)
const { status, data } = await apiInstance.getOrgVariablesList(
org,
page,
limit
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **org** | [**string**] | name of the organization | defaults to undefined|
| **page** | [**number**] | page number of results to return (1-based) | (optional) defaults to undefined|
| **limit** | [**number**] | page size of results | (optional) defaults to undefined|
### Return type
**Array<ActionVariable>**
### 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** | VariableList | - |
|**400** | APIError is error format 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)
# **orgAddTeamMember**
> orgAddTeamMember()
### Example
```typescript
import {
OrganizationApi,
Configuration
} from 'berg';
const configuration = new Configuration();
const apiInstance = new OrganizationApi(configuration);
let id: number; //id of the team (default to undefined)
let username: string; //username of the user to add (default to undefined)
const { status, data } = await apiInstance.orgAddTeamMember(
id,
username
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **id** | [**number**] | id of the team | defaults to undefined|
| **username** | [**string**] | username of the user to add | 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** | 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)
# **orgAddTeamRepository**
> orgAddTeamRepository()
### Example
```typescript
import {
OrganizationApi,
Configuration
} from 'berg';
const configuration = new Configuration();
const apiInstance = new OrganizationApi(configuration);
let id: number; //id of the team (default to undefined)
let org: string; //organization that owns the repo to add (default to undefined)
let repo: string; //name of the repo to add (default to undefined)
const { status, data } = await apiInstance.orgAddTeamRepository(
id,
org,
repo
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **id** | [**number**] | id of the team | defaults to undefined|
| **org** | [**string**] | organization that owns the repo to add | defaults to undefined|
| **repo** | [**string**] | name of the repo to add | 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 | - |
|**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)
# **orgBlockUser**
> orgBlockUser()
### Example
```typescript
import {
OrganizationApi,
Configuration
} from 'berg';
const configuration = new Configuration();
const apiInstance = new OrganizationApi(configuration);
let org: string; //name of the org (default to undefined)
let username: string; //username of the user (default to undefined)
const { status, data } = await apiInstance.orgBlockUser(
org,
username
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **org** | [**string**] | name of the org | defaults to undefined|
| **username** | [**string**] | username of the user | 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** | 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)
# **orgCheckQuota**
> orgCheckQuota()
### Example
```typescript
import {
OrganizationApi,
Configuration
} from 'berg';
const configuration = new Configuration();
const apiInstance = new OrganizationApi(configuration);
let org: string; //name of the organization (default to undefined)
const { status, data } = await apiInstance.orgCheckQuota(
org
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **org** | [**string**] | name of the organization | 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** | Boolean | - |
|**403** | APIForbiddenError is a forbidden error response | - |
|**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)
# **orgConcealMember**
> orgConcealMember()
### Example
```typescript
import {
OrganizationApi,
Configuration
} from 'berg';
const configuration = new Configuration();
const apiInstance = new OrganizationApi(configuration);
let org: string; //name of the organization (default to undefined)
let username: string; //username of the user (default to undefined)
const { status, data } = await apiInstance.orgConcealMember(
org,
username
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **org** | [**string**] | name of the organization | defaults to undefined|
| **username** | [**string**] | username of the user | 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 | - |
|**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)
# **orgCreate**
> Organization orgCreate(organization)
### Example
```typescript
import {
OrganizationApi,
Configuration,
CreateOrgOption
} from 'berg';
const configuration = new Configuration();
const apiInstance = new OrganizationApi(configuration);
let organization: CreateOrgOption; //
const { status, data } = await apiInstance.orgCreate(
organization
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **organization** | **CreateOrgOption**| | |
### Return type
**Organization**
### 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** | Organization | - |
|**403** | APIForbiddenError is a forbidden 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)
# **orgCreateHook**
> Hook orgCreateHook(body)
### Example
```typescript
import {
OrganizationApi,
Configuration,
CreateHookOption
} from 'berg';
const configuration = new Configuration();
const apiInstance = new OrganizationApi(configuration);
let org: string; //name of the organization (default to undefined)
let body: CreateHookOption; //
const { status, data } = await apiInstance.orgCreateHook(
org,
body
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **body** | **CreateHookOption**| | |
| **org** | [**string**] | name of the organization | defaults to undefined|
### Return type
**Hook**
### 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** | Hook | - |
|**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)
# **orgCreateLabel**
> Label orgCreateLabel()
### Example
```typescript
import {
OrganizationApi,
Configuration,
CreateLabelOption
} from 'berg';
const configuration = new Configuration();
const apiInstance = new OrganizationApi(configuration);
let org: string; //name of the organization (default to undefined)
let body: CreateLabelOption; // (optional)
const { status, data } = await apiInstance.orgCreateLabel(
org,
body
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **body** | **CreateLabelOption**| | |
| **org** | [**string**] | name of the organization | 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)
# **orgCreateTeam**
> Team orgCreateTeam()
### Example
```typescript
import {
OrganizationApi,
Configuration,
CreateTeamOption
} from 'berg';
const configuration = new Configuration();
const apiInstance = new OrganizationApi(configuration);
let org: string; //name of the organization (default to undefined)
let body: CreateTeamOption; // (optional)
const { status, data } = await apiInstance.orgCreateTeam(
org,
body
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **body** | **CreateTeamOption**| | |
| **org** | [**string**] | name of the organization | defaults to undefined|
### Return type
**Team**
### 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** | Team | - |
|**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)
# **orgDelete**
> orgDelete()
### Example
```typescript
import {
OrganizationApi,
Configuration
} from 'berg';
const configuration = new Configuration();
const apiInstance = new OrganizationApi(configuration);
let org: string; //organization that is to be deleted (default to undefined)
const { status, data } = await apiInstance.orgDelete(
org
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **org** | [**string**] | organization that is to be deleted | 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** | 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)
# **orgDeleteAvatar**
> orgDeleteAvatar()
### Example
```typescript
import {
OrganizationApi,
Configuration
} from 'berg';
const configuration = new Configuration();
const apiInstance = new OrganizationApi(configuration);
let org: string; //name of the organization (default to undefined)
const { status, data } = await apiInstance.orgDeleteAvatar(
org
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **org** | [**string**] | name of the organization | 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** | 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)
# **orgDeleteHook**
> orgDeleteHook()
### Example
```typescript
import {
OrganizationApi,
Configuration
} from 'berg';
const configuration = new Configuration();
const apiInstance = new OrganizationApi(configuration);
let org: string; //name of the organization (default to undefined)
let id: number; //id of the hook to delete (default to undefined)
const { status, data } = await apiInstance.orgDeleteHook(
org,
id
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **org** | [**string**] | name of the organization | defaults to undefined|
| **id** | [**number**] | id of the hook 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** | 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)
# **orgDeleteLabel**
> orgDeleteLabel()
### Example
```typescript
import {
OrganizationApi,
Configuration
} from 'berg';
const configuration = new Configuration();
const apiInstance = new OrganizationApi(configuration);
let org: string; //name of the organization (default to undefined)
let id: number; //id of the label to delete (default to undefined)
const { status, data } = await apiInstance.orgDeleteLabel(
org,
id
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **org** | [**string**] | name of the organization | defaults to undefined|
| **id** | [**number**] | id of the label 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 | - |
|**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)
# **orgDeleteMember**
> orgDeleteMember()
### Example
```typescript
import {
OrganizationApi,
Configuration
} from 'berg';
const configuration = new Configuration();
const apiInstance = new OrganizationApi(configuration);
let org: string; //name of the organization (default to undefined)
let username: string; //username of the user (default to undefined)
const { status, data } = await apiInstance.orgDeleteMember(
org,
username
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **org** | [**string**] | name of the organization | defaults to undefined|
| **username** | [**string**] | username of the user | 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** | member removed | - |
|**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)
# **orgDeleteTeam**
> orgDeleteTeam()
### Example
```typescript
import {
OrganizationApi,
Configuration
} from 'berg';
const configuration = new Configuration();
const apiInstance = new OrganizationApi(configuration);
let id: number; //id of the team to delete (default to undefined)
const { status, data } = await apiInstance.orgDeleteTeam(
id
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **id** | [**number**] | id of the team 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** | team deleted | - |
|**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)
# **orgEdit**
> Organization orgEdit(body)
### Example
```typescript
import {
OrganizationApi,
Configuration,
EditOrgOption
} from 'berg';
const configuration = new Configuration();
const apiInstance = new OrganizationApi(configuration);
let org: string; //name of the organization to edit (default to undefined)
let body: EditOrgOption; //
const { status, data } = await apiInstance.orgEdit(
org,
body
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **body** | **EditOrgOption**| | |
| **org** | [**string**] | name of the organization to edit | defaults to undefined|
### Return type
**Organization**
### 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** | Organization | - |
|**404** | APINotFound is a not found error response | - |
|**422** | APIError is error format 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)
# **orgEditHook**
> Hook orgEditHook()
### Example
```typescript
import {
OrganizationApi,
Configuration,
EditHookOption
} from 'berg';
const configuration = new Configuration();
const apiInstance = new OrganizationApi(configuration);
let org: string; //name of the organization (default to undefined)
let id: number; //id of the hook to update (default to undefined)
let body: EditHookOption; // (optional)
const { status, data } = await apiInstance.orgEditHook(
org,
id,
body
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **body** | **EditHookOption**| | |
| **org** | [**string**] | name of the organization | defaults to undefined|
| **id** | [**number**] | id of the hook to update | defaults to undefined|
### Return type
**Hook**
### 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** | Hook | - |
|**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)
# **orgEditLabel**
> Label orgEditLabel()
### Example
```typescript
import {
OrganizationApi,
Configuration,
EditLabelOption
} from 'berg';
const configuration = new Configuration();
const apiInstance = new OrganizationApi(configuration);
let org: string; //name of the organization (default to undefined)
let id: number; //id of the label to edit (default to undefined)
let body: EditLabelOption; // (optional)
const { status, data } = await apiInstance.orgEditLabel(
org,
id,
body
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **body** | **EditLabelOption**| | |
| **org** | [**string**] | name of the organization | defaults to undefined|
| **id** | [**number**] | id of the label to edit | 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 |
|-------------|-------------|------------------|
|**200** | 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)
# **orgEditTeam**
> Team orgEditTeam()
### Example
```typescript
import {
OrganizationApi,
Configuration,
EditTeamOption
} from 'berg';
const configuration = new Configuration();
const apiInstance = new OrganizationApi(configuration);
let id: number; //id of the team to edit (default to undefined)
let body: EditTeamOption; // (optional)
const { status, data } = await apiInstance.orgEditTeam(
id,
body
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **body** | **EditTeamOption**| | |
| **id** | [**number**] | id of the team to edit | defaults to undefined|
### Return type
**Team**
### 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** | Team | - |
|**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)
# **orgGet**
> Organization orgGet()
### Example
```typescript
import {
OrganizationApi,
Configuration
} from 'berg';
const configuration = new Configuration();
const apiInstance = new OrganizationApi(configuration);
let org: st