# PartnershipManagement.PartnershipApi

All URIs are relative to *https://serverRoot/tmf-api/partnershipManagement/v4/*

Method | HTTP request | Description
------------- | ------------- | -------------
[**createPartnership**](PartnershipApi.md#createPartnership) | **POST** /partnership | Creates a Partnership
[**deletePartnership**](PartnershipApi.md#deletePartnership) | **DELETE** /partnership/{id} | Deletes a Partnership
[**listPartnership**](PartnershipApi.md#listPartnership) | **GET** /partnership | List or find Partnership objects
[**patchPartnership**](PartnershipApi.md#patchPartnership) | **PATCH** /partnership/{id} | Updates partially a Partnership
[**retrievePartnership**](PartnershipApi.md#retrievePartnership) | **GET** /partnership/{id} | Retrieves a Partnership by ID

<a name="createPartnership"></a>
# **createPartnership**
> Partnership createPartnership(body)

Creates a Partnership

This operation creates a Partnership entity.

### Example
```javascript
import {PartnershipManagement} from 'partnership_management';

let apiInstance = new PartnershipManagement.PartnershipApi();
let body = new PartnershipManagement.PartnershipCreate(); // PartnershipCreate | The Partnership to be created

apiInstance.createPartnership(body, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**PartnershipCreate**](PartnershipCreate.md)| The Partnership to be created | 

### Return type

[**Partnership**](Partnership.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json;charset=utf-8
 - **Accept**: application/json;charset=utf-8

<a name="deletePartnership"></a>
# **deletePartnership**
> deletePartnership(id)

Deletes a Partnership

This operation deletes a Partnership entity.

### Example
```javascript
import {PartnershipManagement} from 'partnership_management';

let apiInstance = new PartnershipManagement.PartnershipApi();
let id = "id_example"; // String | Identifier of the Partnership

apiInstance.deletePartnership(id, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**| Identifier of the Partnership | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json;charset=utf-8

<a name="listPartnership"></a>
# **listPartnership**
> [Partnership] listPartnership(opts)

List or find Partnership objects

This operation list or find Partnership entities

### Example
```javascript
import {PartnershipManagement} from 'partnership_management';

let apiInstance = new PartnershipManagement.PartnershipApi();
let opts = { 
  'fields': "fields_example", // String | Comma-separated properties to be provided in response
  'offset': 56, // Number | Requested index for start of resources to be provided in response
  'limit': 56 // Number | Requested number of resources to be provided in response
};
apiInstance.listPartnership(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **fields** | **String**| Comma-separated properties to be provided in response | [optional] 
 **offset** | **Number**| Requested index for start of resources to be provided in response | [optional] 
 **limit** | **Number**| Requested number of resources to be provided in response | [optional] 

### Return type

[**[Partnership]**](Partnership.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json;charset=utf-8

<a name="patchPartnership"></a>
# **patchPartnership**
> Partnership patchPartnership(body, id)

Updates partially a Partnership

This operation updates partially a Partnership entity.

### Example
```javascript
import {PartnershipManagement} from 'partnership_management';

let apiInstance = new PartnershipManagement.PartnershipApi();
let body = new PartnershipManagement.PartnershipUpdate(); // PartnershipUpdate | The Partnership to be updated
let id = "id_example"; // String | Identifier of the Partnership

apiInstance.patchPartnership(body, id, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**PartnershipUpdate**](PartnershipUpdate.md)| The Partnership to be updated | 
 **id** | **String**| Identifier of the Partnership | 

### Return type

[**Partnership**](Partnership.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json;charset=utf-8
 - **Accept**: application/json;charset=utf-8

<a name="retrievePartnership"></a>
# **retrievePartnership**
> Partnership retrievePartnership(id, opts)

Retrieves a Partnership by ID

This operation retrieves a Partnership entity. Attribute selection is enabled for all first level attributes.

### Example
```javascript
import {PartnershipManagement} from 'partnership_management';

let apiInstance = new PartnershipManagement.PartnershipApi();
let id = "id_example"; // String | Identifier of the Partnership
let opts = { 
  'fields': "fields_example" // String | Comma-separated properties to provide in response
};
apiInstance.retrievePartnership(id, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**| Identifier of the Partnership | 
 **fields** | **String**| Comma-separated properties to provide in response | [optional] 

### Return type

[**Partnership**](Partnership.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json;charset=utf-8