enbbox 1.0.1

# \LayoutsApi

All URIs are relative to *https://api.enbbox.com*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_layout**](LayoutsApi.md#create_layout) | **POST** /v1/layouts/ | POST /v1/layouts
[**delete_layout**](LayoutsApi.md#delete_layout) | **DELETE** /v1/layouts/{id}/ | DELETE /v1/layouts/:id
[**duplicate_layout**](LayoutsApi.md#duplicate_layout) | **POST** /v1/layouts/{id}/duplicate/ | POST /v1/layouts/:id/duplicate — clone layout
[**get_layout**](LayoutsApi.md#get_layout) | **GET** /v1/layouts/{id}/ | GET /v1/layouts/:id
[**layout_usage**](LayoutsApi.md#layout_usage) | **GET** /v1/layouts/{id}/usage/ | GET /v1/layouts/:id/usage — list workflows using this layout
[**list_layouts**](LayoutsApi.md#list_layouts) | **GET** /v1/layouts/ | GET /v1/layouts
[**preview_layout**](LayoutsApi.md#preview_layout) | **POST** /v1/layouts/{id}/preview/ | POST /v1/layouts/:id/preview — render layout with sample content
[**set_default**](LayoutsApi.md#set_default) | **POST** /v1/layouts/{id}/default/ | POST /v1/layouts/:id/default
[**update_layout**](LayoutsApi.md#update_layout) | **PATCH** /v1/layouts/{id}/ | PATCH /v1/layouts/:id



## create_layout

> models::LayoutRecord create_layout(create_layout)
POST /v1/layouts

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**create_layout** | [**CreateLayout**](CreateLayout.md) |  | [required] |

### Return type

[**models::LayoutRecord**](LayoutRecord.md)

### Authorization

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

### HTTP request headers

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

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


## delete_layout

> delete_layout(id)
DELETE /v1/layouts/:id

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Layout ID | [required] |

### Return type

 (empty response body)

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

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


## duplicate_layout

> models::LayoutRecord duplicate_layout(id)
POST /v1/layouts/:id/duplicate — clone layout

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** |  | [required] |

### Return type

[**models::LayoutRecord**](LayoutRecord.md)

### Authorization

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

### HTTP request headers

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

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


## get_layout

> models::LayoutRecord get_layout(id)
GET /v1/layouts/:id

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Layout ID | [required] |

### Return type

[**models::LayoutRecord**](LayoutRecord.md)

### Authorization

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

### HTTP request headers

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

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


## layout_usage

> Vec<models::LayoutUsageItem> layout_usage(id)
GET /v1/layouts/:id/usage — list workflows using this layout

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** |  | [required] |

### Return type

[**Vec<models::LayoutUsageItem>**](LayoutUsageItem.md)

### Authorization

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

### HTTP request headers

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

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


## list_layouts

> models::PaginatedLayoutRecord list_layouts(limit, offset, q, filter_by)
GET /v1/layouts

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**limit** | Option<**u32**> | Maximum number of items to return (1–100, default: 10). |  |
**offset** | Option<**u32**> | Number of items to skip before returning results (default: 0). |  |
**q** | Option<**String**> | Optional full-text search query. When present, listing is powered by Typesense full-text search. |  |
**filter_by** | Option<**String**> | Optional Typesense filter expression for narrowing results. Example: `identifier:=acme-corp` or `name:=General`. |  |

### Return type

[**models::PaginatedLayoutRecord**](Paginated_LayoutRecord.md)

### Authorization

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

### HTTP request headers

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

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


## preview_layout

> models::LayoutPreviewResult preview_layout(id, layout_preview)
POST /v1/layouts/:id/preview — render layout with sample content

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** |  | [required] |
**layout_preview** | [**LayoutPreview**](LayoutPreview.md) |  | [required] |

### Return type

[**models::LayoutPreviewResult**](LayoutPreviewResult.md)

### Authorization

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

### HTTP request headers

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

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


## set_default

> models::LayoutRecord set_default(id)
POST /v1/layouts/:id/default

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Layout ID | [required] |

### Return type

[**models::LayoutRecord**](LayoutRecord.md)

### Authorization

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

### HTTP request headers

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

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

> models::LayoutRecord update_layout(id, update_layout)
PATCH /v1/layouts/:id

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Layout ID | [required] |
**update_layout** | [**UpdateLayout**](UpdateLayout.md) |  | [required] |

### Return type

[**models::LayoutRecord**](LayoutRecord.md)

### Authorization

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

### HTTP request headers

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

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