# TransactionChannelsApi

All URIs are relative to *http://localhost:8889/api*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**_delete**](#_delete) | **DELETE** /organization/transactionChannels/{transactionChannelId} | Delete transaction channel|
|[**create**](#create) | **POST** /organization/transactionChannels | Create transaction channel|
|[**getAll**](#getall) | **GET** /organization/transactionChannels | Get transaction channels|
|[**getById**](#getbyid) | **GET** /organization/transactionChannels/{transactionChannelId} | Get transaction channel|
|[**update**](#update) | **PUT** /organization/transactionChannels/{transactionChannelId} | Update transaction channel|

# **_delete**
> _delete()


### Example

```typescript
import {
    TransactionChannelsApi,
    Configuration
} from './api';

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

let transactionChannelId: string; //The ID of the transaction channel to be deleted. (default to undefined)

const { status, data } = await apiInstance._delete(
    transactionChannelId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **transactionChannelId** | [**string**] | The ID of the transaction channel to be deleted. | defaults to undefined|


### Return type

void (empty response body)

### Authorization

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

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/vnd.mambu.v2+json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**204** | Transaction channel deleted. |  -  |
|**400** | A validation error occurred |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |
|**404** | Transaction channel not found. |  -  |

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

# **create**
> TransactionChannel create(transactionChannel)


### Example

```typescript
import {
    TransactionChannelsApi,
    Configuration,
    TransactionChannel
} from './api';

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

let transactionChannel: TransactionChannel; //Values to create the transaction channel.
let idempotencyKey: string; //Key that can be used to support idempotency on this POST. Must be a valid UUID(version 4 is recommended) string and can only be used with the exact same request. Can be used in retry mechanisms to prevent double posting. (optional) (default to undefined)

const { status, data } = await apiInstance.create(
    transactionChannel,
    idempotencyKey
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **transactionChannel** | **TransactionChannel**| Values to create the transaction channel. | |
| **idempotencyKey** | [**string**] | Key that can be used to support idempotency on this POST. Must be a valid UUID(version 4 is recommended) string and can only be used with the exact same request. Can be used in retry mechanisms to prevent double posting. | (optional) defaults to undefined|


### Return type

**TransactionChannel**

### Authorization

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

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/vnd.mambu.v2+json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**102** | Your idempotent request was already submitted and is currently being processed, try again later. |  -  |
|**201** | Transaction channel created. |  -  |
|**400** | A validation error occurred |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |

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

# **getAll**
> Array<TransactionChannel> getAll()


### Example

```typescript
import {
    TransactionChannelsApi,
    Configuration
} from './api';

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

let detailsLevel: 'BASIC' | 'FULL'; //The level of details to return: `FULL` means the full details of the object will be returned (custom field values, address, contact info, or any other related objects) and `BASIC` will return only the first level elements of the object. (optional) (default to undefined)
let transactionChannelState: 'ACTIVE' | 'INACTIVE'; //The state of the transaction channels to search for. (optional) (default to undefined)

const { status, data } = await apiInstance.getAll(
    detailsLevel,
    transactionChannelState
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **detailsLevel** | [**&#39;BASIC&#39; | &#39;FULL&#39;**]**Array<&#39;BASIC&#39; &#124; &#39;FULL&#39;>** | The level of details to return: &#x60;FULL&#x60; means the full details of the object will be returned (custom field values, address, contact info, or any other related objects) and &#x60;BASIC&#x60; will return only the first level elements of the object. | (optional) defaults to undefined|
| **transactionChannelState** | [**&#39;ACTIVE&#39; | &#39;INACTIVE&#39;**]**Array<&#39;ACTIVE&#39; &#124; &#39;INACTIVE&#39;>** | The state of the transaction channels to search for. | (optional) defaults to undefined|


### Return type

**Array<TransactionChannel>**

### Authorization

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

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/vnd.mambu.v2+json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Transaction channels returned. |  -  |
|**400** | A validation error occurred |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |

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

# **getById**
> TransactionChannel getById()


### Example

```typescript
import {
    TransactionChannelsApi,
    Configuration
} from './api';

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

let transactionChannelId: string; //The ID of the transaction channel to be returned. (default to undefined)
let detailsLevel: 'BASIC' | 'FULL'; //The level of details to return: `FULL` means the full details of the object will be returned (custom field values, address, contact info, or any other related objects) and `BASIC` will return only the first level elements of the object. (optional) (default to undefined)

const { status, data } = await apiInstance.getById(
    transactionChannelId,
    detailsLevel
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **transactionChannelId** | [**string**] | The ID of the transaction channel to be returned. | defaults to undefined|
| **detailsLevel** | [**&#39;BASIC&#39; | &#39;FULL&#39;**]**Array<&#39;BASIC&#39; &#124; &#39;FULL&#39;>** | The level of details to return: &#x60;FULL&#x60; means the full details of the object will be returned (custom field values, address, contact info, or any other related objects) and &#x60;BASIC&#x60; will return only the first level elements of the object. | (optional) defaults to undefined|


### Return type

**TransactionChannel**

### Authorization

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

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/vnd.mambu.v2+json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Transaction channel returned. |  -  |
|**400** | A validation error occurred |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |
|**404** | Transaction channel not found. |  -  |

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

# **update**
> update(transactionChannel)


### Example

```typescript
import {
    TransactionChannelsApi,
    Configuration,
    TransactionChannel
} from './api';

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

let transactionChannelId: string; //ID for the transaction channel to be updated. (default to undefined)
let transactionChannel: TransactionChannel; //Values to update the transaction channel.

const { status, data } = await apiInstance.update(
    transactionChannelId,
    transactionChannel
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **transactionChannel** | **TransactionChannel**| Values to update the transaction channel. | |
| **transactionChannelId** | [**string**] | ID for the transaction channel to be updated. | defaults to undefined|


### Return type

void (empty response body)

### Authorization

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

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/vnd.mambu.v2+json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Transaction channel updated. |  -  |
|**400** | A validation error occurred |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |
|**404** | Transaction channel not found. |  -  |

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