# BroadcastMessagesApi

All URIs are relative to *https://www.gitlab.com/api/v4*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**deleteApiV4BroadcastMessagesId**](#deleteapiv4broadcastmessagesid) | **DELETE** /broadcast_messages/{id} | Delete a broadcast message|
|[**getApiV4BroadcastMessages**](#getapiv4broadcastmessages) | **GET** /broadcast_messages | Get all broadcast messages|
|[**getApiV4BroadcastMessagesId**](#getapiv4broadcastmessagesid) | **GET** /broadcast_messages/{id} | Get a specific broadcast message|
|[**postApiV4BroadcastMessages**](#postapiv4broadcastmessages) | **POST** /broadcast_messages | Create a broadcast message|
|[**putApiV4BroadcastMessagesId**](#putapiv4broadcastmessagesid) | **PUT** /broadcast_messages/{id} | Update a broadcast message|

# **deleteApiV4BroadcastMessagesId**
> APIEntitiesBroadcastMessage deleteApiV4BroadcastMessagesId()

This feature was introduced in GitLab 8.12.

### Example

```typescript
import {
    BroadcastMessagesApi,
    Configuration
} from 'berg';

const configuration = new Configuration();
const apiInstance = new BroadcastMessagesApi(configuration);

let id: number; //Broadcast message ID (default to undefined)

const { status, data } = await apiInstance.deleteApiV4BroadcastMessagesId(
    id
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **id** | [**number**] | Broadcast message ID | defaults to undefined|


### Return type

**APIEntitiesBroadcastMessage**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Delete a broadcast message |  -  |

[[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)

# **getApiV4BroadcastMessages**
> APIEntitiesBroadcastMessage getApiV4BroadcastMessages()

This feature was introduced in GitLab 8.12.

### Example

```typescript
import {
    BroadcastMessagesApi,
    Configuration
} from 'berg';

const configuration = new Configuration();
const apiInstance = new BroadcastMessagesApi(configuration);

let page: number; //Current page number (optional) (default to 1)
let perPage: number; //Number of items per page (optional) (default to 20)

const { status, data } = await apiInstance.getApiV4BroadcastMessages(
    page,
    perPage
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **page** | [**number**] | Current page number | (optional) defaults to 1|
| **perPage** | [**number**] | Number of items per page | (optional) defaults to 20|


### Return type

**APIEntitiesBroadcastMessage**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Get all broadcast messages |  -  |

[[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)

# **getApiV4BroadcastMessagesId**
> APIEntitiesBroadcastMessage getApiV4BroadcastMessagesId()

This feature was introduced in GitLab 8.12.

### Example

```typescript
import {
    BroadcastMessagesApi,
    Configuration
} from 'berg';

const configuration = new Configuration();
const apiInstance = new BroadcastMessagesApi(configuration);

let id: number; //Broadcast message ID (default to undefined)

const { status, data } = await apiInstance.getApiV4BroadcastMessagesId(
    id
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **id** | [**number**] | Broadcast message ID | defaults to undefined|


### Return type

**APIEntitiesBroadcastMessage**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Get a specific broadcast message |  -  |

[[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)

# **postApiV4BroadcastMessages**
> APIEntitiesBroadcastMessage postApiV4BroadcastMessages(postApiV4BroadcastMessagesRequest)

This feature was introduced in GitLab 8.12.

### Example

```typescript
import {
    BroadcastMessagesApi,
    Configuration,
    PostApiV4BroadcastMessagesRequest
} from 'berg';

const configuration = new Configuration();
const apiInstance = new BroadcastMessagesApi(configuration);

let postApiV4BroadcastMessagesRequest: PostApiV4BroadcastMessagesRequest; //

const { status, data } = await apiInstance.postApiV4BroadcastMessages(
    postApiV4BroadcastMessagesRequest
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **postApiV4BroadcastMessagesRequest** | **PostApiV4BroadcastMessagesRequest**|  | |


### Return type

**APIEntitiesBroadcastMessage**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**201** | Create a broadcast message |  -  |

[[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)

# **putApiV4BroadcastMessagesId**
> APIEntitiesBroadcastMessage putApiV4BroadcastMessagesId()

This feature was introduced in GitLab 8.12.

### Example

```typescript
import {
    BroadcastMessagesApi,
    Configuration,
    PutApiV4BroadcastMessagesIdRequest
} from 'berg';

const configuration = new Configuration();
const apiInstance = new BroadcastMessagesApi(configuration);

let id: number; //Broadcast message ID (default to undefined)
let putApiV4BroadcastMessagesIdRequest: PutApiV4BroadcastMessagesIdRequest; // (optional)

const { status, data } = await apiInstance.putApiV4BroadcastMessagesId(
    id,
    putApiV4BroadcastMessagesIdRequest
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **putApiV4BroadcastMessagesIdRequest** | **PutApiV4BroadcastMessagesIdRequest**|  | |
| **id** | [**number**] | Broadcast message ID | defaults to undefined|


### Return type

**APIEntitiesBroadcastMessage**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Update a broadcast message |  -  |

[[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)