# StevenBuehner\ChurchTools\WikiApi

Endpoints for Wiki

All URIs are relative to /api, except if the operation defines another base path.

| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**getWikiCategories()**](WikiApi.md#getWikiCategories) | **GET** /wiki/categories | Get all wiki categories. |
| [**getWikiCategoriesWikiCategoryIdPages()**](WikiApi.md#getWikiCategoriesWikiCategoryIdPages) | **GET** /wiki/categories/{wikiCategoryId}/pages | Returns all Wiki Pages in the given Category. |
| [**getWikiCategoriesWikiCategoryIdPagesIdentifier()**](WikiApi.md#getWikiCategoriesWikiCategoryIdPagesIdentifier) | **GET** /wiki/categories/{wikiCategoryId}/pages/{identifier} | Returns the latest version of the wiki page with the given identifier. |
| [**getWikiCategoriesWikiCategoryIdPagesIdentifierVersions()**](WikiApi.md#getWikiCategoriesWikiCategoryIdPagesIdentifierVersions) | **GET** /wiki/categories/{wikiCategoryId}/pages/{identifier}/versions | Returns all version of the wiki page for the given |
| [**getWikiCategoriesWikiCategoryIdPagesVersionsVersion()**](WikiApi.md#getWikiCategoriesWikiCategoryIdPagesVersionsVersion) | **GET** /wiki/categories/{wikiCategoryId}/pages/{identifier}/versions/{version} | Returns the wiki page with the given identifier and version. |
| [**getWikiCategoriesWikiCategoryIdSearch()**](WikiApi.md#getWikiCategoriesWikiCategoryIdSearch) | **GET** /wiki/search | Your GET endpoint |


## `getWikiCategories()`

```php
getWikiCategories(): \StevenBuehner\ChurchTools\Model\GetWikiCategories200Response
```

Get all wiki categories.

Get all wiki categories.

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Login-Token-Header
$config = StevenBuehner\ChurchTools\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = StevenBuehner\ChurchTools\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new StevenBuehner\ChurchTools\Api\WikiApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->getWikiCategories();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WikiApi->getWikiCategories: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

This endpoint does not need any parameter.

### Return type

[**\StevenBuehner\ChurchTools\Model\GetWikiCategories200Response**](../Model/GetWikiCategories200Response.md)

### Authorization

[Login-Token-Header](../../README.md#Login-Token-Header)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `getWikiCategoriesWikiCategoryIdPages()`

```php
getWikiCategoriesWikiCategoryIdPages($wiki_category_id): \StevenBuehner\ChurchTools\Model\GetWikiCategoriesWikiCategoryIdPages200Response
```

Returns all Wiki Pages in the given Category.

Returns all Wiki Pages in the given Category. Only the latest version of each page is returned.

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Login-Token-Header
$config = StevenBuehner\ChurchTools\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = StevenBuehner\ChurchTools\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new StevenBuehner\ChurchTools\Api\WikiApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$wiki_category_id = 42; // int | ID of WikiCategory

try {
    $result = $apiInstance->getWikiCategoriesWikiCategoryIdPages($wiki_category_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WikiApi->getWikiCategoriesWikiCategoryIdPages: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **wiki_category_id** | **int**| ID of WikiCategory | |

### Return type

[**\StevenBuehner\ChurchTools\Model\GetWikiCategoriesWikiCategoryIdPages200Response**](../Model/GetWikiCategoriesWikiCategoryIdPages200Response.md)

### Authorization

[Login-Token-Header](../../README.md#Login-Token-Header)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `getWikiCategoriesWikiCategoryIdPagesIdentifier()`

```php
getWikiCategoriesWikiCategoryIdPagesIdentifier($wiki_category_id, $identifier): \StevenBuehner\ChurchTools\Model\GetWikiCategoriesWikiCategoryIdPagesIdentifier200Response
```

Returns the latest version of the wiki page with the given identifier.

Returns the latest version of the wiki page with the given identifier.

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Login-Token-Header
$config = StevenBuehner\ChurchTools\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = StevenBuehner\ChurchTools\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new StevenBuehner\ChurchTools\Api\WikiApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$wiki_category_id = 42; // int | ID of WikiCategory
$identifier = 'identifier_example'; // string | Can either be the pages identifier or its title

try {
    $result = $apiInstance->getWikiCategoriesWikiCategoryIdPagesIdentifier($wiki_category_id, $identifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WikiApi->getWikiCategoriesWikiCategoryIdPagesIdentifier: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **wiki_category_id** | **int**| ID of WikiCategory | |
| **identifier** | **string**| Can either be the pages identifier or its title | |

### Return type

[**\StevenBuehner\ChurchTools\Model\GetWikiCategoriesWikiCategoryIdPagesIdentifier200Response**](../Model/GetWikiCategoriesWikiCategoryIdPagesIdentifier200Response.md)

### Authorization

[Login-Token-Header](../../README.md#Login-Token-Header)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `getWikiCategoriesWikiCategoryIdPagesIdentifierVersions()`

```php
getWikiCategoriesWikiCategoryIdPagesIdentifierVersions($wiki_category_id, $identifier): \StevenBuehner\ChurchTools\Model\GetWikiCategoriesWikiCategoryIdPagesIdentifier200Response
```

Returns all version of the wiki page for the given

Returns all version of the wiki page for the given identifier.

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Login-Token-Header
$config = StevenBuehner\ChurchTools\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = StevenBuehner\ChurchTools\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new StevenBuehner\ChurchTools\Api\WikiApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$wiki_category_id = 42; // int | ID of WikiCategory
$identifier = 'identifier_example'; // string | Can either be the pages identifier or its title

try {
    $result = $apiInstance->getWikiCategoriesWikiCategoryIdPagesIdentifierVersions($wiki_category_id, $identifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WikiApi->getWikiCategoriesWikiCategoryIdPagesIdentifierVersions: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **wiki_category_id** | **int**| ID of WikiCategory | |
| **identifier** | **string**| Can either be the pages identifier or its title | |

### Return type

[**\StevenBuehner\ChurchTools\Model\GetWikiCategoriesWikiCategoryIdPagesIdentifier200Response**](../Model/GetWikiCategoriesWikiCategoryIdPagesIdentifier200Response.md)

### Authorization

[Login-Token-Header](../../README.md#Login-Token-Header)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `getWikiCategoriesWikiCategoryIdPagesVersionsVersion()`

```php
getWikiCategoriesWikiCategoryIdPagesVersionsVersion($wiki_category_id, $version, $identifier): \StevenBuehner\ChurchTools\Model\GetWikiCategoriesWikiCategoryIdPagesVersionsVersion200Response
```

Returns the wiki page with the given identifier and version.

Returns the wiki page with the given identifier and version.

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Login-Token-Header
$config = StevenBuehner\ChurchTools\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = StevenBuehner\ChurchTools\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new StevenBuehner\ChurchTools\Api\WikiApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$wiki_category_id = 42; // int | ID of WikiCategory
$version = 'version_example'; // string
$identifier = 'identifier_example'; // string | Can either be the pages identifier or its title

try {
    $result = $apiInstance->getWikiCategoriesWikiCategoryIdPagesVersionsVersion($wiki_category_id, $version, $identifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WikiApi->getWikiCategoriesWikiCategoryIdPagesVersionsVersion: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **wiki_category_id** | **int**| ID of WikiCategory | |
| **version** | **string**|  | |
| **identifier** | **string**| Can either be the pages identifier or its title | |

### Return type

[**\StevenBuehner\ChurchTools\Model\GetWikiCategoriesWikiCategoryIdPagesVersionsVersion200Response**](../Model/GetWikiCategoriesWikiCategoryIdPagesVersionsVersion200Response.md)

### Authorization

[Login-Token-Header](../../README.md#Login-Token-Header)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `getWikiCategoriesWikiCategoryIdSearch()`

```php
getWikiCategoriesWikiCategoryIdSearch($query, $wiki_category_ids): \StevenBuehner\ChurchTools\Model\GetWikiCategoriesWikiCategoryIdSearch200Response
```

Your GET endpoint

Full text search in all wiki pages

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Login-Token-Header
$config = StevenBuehner\ChurchTools\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = StevenBuehner\ChurchTools\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new StevenBuehner\ChurchTools\Api\WikiApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$query = 'query_example'; // string
$wiki_category_ids = array(56); // int[] | wiki categories that should be searched. if noone is given all categories are searched

try {
    $result = $apiInstance->getWikiCategoriesWikiCategoryIdSearch($query, $wiki_category_ids);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WikiApi->getWikiCategoriesWikiCategoryIdSearch: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **query** | **string**|  | [optional] |
| **wiki_category_ids** | [**int[]**](../Model/int.md)| wiki categories that should be searched. if noone is given all categories are searched | [optional] |

### Return type

[**\StevenBuehner\ChurchTools\Model\GetWikiCategoriesWikiCategoryIdSearch200Response**](../Model/GetWikiCategoriesWikiCategoryIdSearch200Response.md)

### Authorization

[Login-Token-Header](../../README.md#Login-Token-Header)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
