# PDFToolsApi

All URIs are relative to *http://localhost:8081*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**info**](#info) | **GET** /api/v1/pdf/{documentId}/info | Describe a stored PDF|
|[**merge**](#merge) | **POST** /api/v1/pdf/merge | Merge PDFs|
|[**organize**](#organize) | **POST** /api/v1/pdf/organize | Reorganise the pages of a PDF|
|[**rotate**](#rotate) | **POST** /api/v1/pdf/rotate | Rotate pages|
|[**split**](#split) | **POST** /api/v1/pdf/split | Split a PDF|

# **info**
> PdfInfo info()

Page count and geometry, bookmarks, and whether the file is password-protected or digitally signed.

### Example

```typescript
import {
    PDFToolsApi,
    Configuration
} from '@openfilz-sdk/typescript';

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

let documentId: string; //PDF document id (default to undefined)

const { status, data } = await apiInstance.info(
    documentId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **documentId** | [**string**] | PDF document id | defaults to undefined|


### Return type

**PdfInfo**

### Authorization

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

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | OK |  -  |

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

# **merge**
> PdfOperationResponse merge(mergeRequest)

Concatenate several PDFs (or page selections of them) into one document, in the given order, optionally with one bookmark per source. Default output: a new document next to the first source.

### Example

```typescript
import {
    PDFToolsApi,
    Configuration,
    MergeRequest
} from '@openfilz-sdk/typescript';

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

let mergeRequest: MergeRequest; //

const { status, data } = await apiInstance.merge(
    mergeRequest
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **mergeRequest** | **MergeRequest**|  | |


### Return type

**PdfOperationResponse**

### Authorization

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

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | OK |  -  |

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

# **organize**
> PdfOperationResponse organize(organizeRequest)

The result is exactly the listed pages, in order: reorder, delete, duplicate, rotate individual pages, extract a selection, or insert pages from other PDFs. Default output: a new version of the main document.

### Example

```typescript
import {
    PDFToolsApi,
    Configuration,
    OrganizeRequest
} from '@openfilz-sdk/typescript';

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

let organizeRequest: OrganizeRequest; //

const { status, data } = await apiInstance.organize(
    organizeRequest
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **organizeRequest** | **OrganizeRequest**|  | |


### Return type

**PdfOperationResponse**

### Authorization

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

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | OK |  -  |

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

# **rotate**
> PdfOperationResponse rotate(rotateRequest)

Rotate all or selected pages of one or several PDFs by 90, 180 or 270 degrees, one output per document. Default output: a new version of each document.

### Example

```typescript
import {
    PDFToolsApi,
    Configuration,
    RotateRequest
} from '@openfilz-sdk/typescript';

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

let rotateRequest: RotateRequest; //

const { status, data } = await apiInstance.rotate(
    rotateRequest
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **rotateRequest** | **RotateRequest**|  | |


### Return type

**PdfOperationResponse**

### Authorization

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

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | OK |  -  |

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

# **split**
> PdfOperationResponse split(splitRequest)

Cut one PDF into several new documents: every N pages, at given pages, by explicit page ranges, one document per page, or at bookmarks. Names follow a pattern ({name}, {index}, {first}, {last}, {title}).

### Example

```typescript
import {
    PDFToolsApi,
    Configuration,
    SplitRequest
} from '@openfilz-sdk/typescript';

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

let splitRequest: SplitRequest; //

const { status, data } = await apiInstance.split(
    splitRequest
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **splitRequest** | **SplitRequest**|  | |


### Return type

**PdfOperationResponse**

### Authorization

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

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | OK |  -  |

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