endpoint results from the CPAN

endpoint

BmltClient-ApiClient

view release on metacpan or search on metacpan


        package main;

        my $api = MyApp->new({ tokens => $tokens });

        my $pet = $api->get_pet_by_id(pet_id => $pet_id);


## Structure of the library

The library consists of a set of API classes, one for each endpoint. These APIs
implement the method calls available on each endpoint.

Additionally, there is a set of "object" classes, which represent the objects
returned by and sent to the methods on the endpoints.

An API factory class is provided, which builds instances of each endpoint API.

This Moose role flattens all the methods from the endpoint APIs onto the consuming
class. It also provides methods to retrieve the endpoint API objects, and the API
factory object, should you need it.

For documentation of all these methods, see AUTOMATIC DOCUMENTATION below.

## Configuring authentication

In the normal case, the OpenAPI Spec will describe what parameters are
required and where to put them. You just need to supply the tokens.

    my $tokens = {

README.md view on Meta::CPAN

## `api_factory`

Returns an API factory object. You probably won't need to call this directly.

        $self->api_factory('Pet'); # returns a BmltClient::PetApi instance

        $self->pet_api;            # the same

# MISSING METHODS

Most of the methods on the API are delegated to individual endpoint API objects
(e.g. Pet API, Store API, User API etc). Where different endpoint APIs use the
same method name (e.g. `new()`), these methods can't be delegated. So you need
to call `$api->pet_api->new()`.

In principle, every API is susceptible to the presence of a few, random, undelegatable
method names. In practice, because of the way method names are constructed, it's
unlikely in general that any methods will be undelegatable, except for:

        new()
        class_documentation()
        method_documentation()

README.md view on Meta::CPAN



The `-c` option allows you to load and inspect your own application. A dummy
namespace is used if you don't supply your own class.

# DOCUMENTATION FROM THE OpenAPI Spec

Additional documentation for each class and method may be provided by the OpenAPI
spec. If so, this is available via the `class_documentation()` and
`method_documentation()` methods on each generated object class, and the
`method_documentation()` method on the endpoint API classes:

        my $cmdoc = $api->pet_api->method_documentation->{$method_name};

        my $odoc = $api->get_pet_by_id->(pet_id => $pet_id)->class_documentation;
        my $omdoc = $api->get_pet_by_id->(pet_id => $pet_id)->method_documentation->{method_name};


Each of these calls returns a hashref with various useful pieces of information.

# Installation Prerequisites

docs/AuthenticationError.md view on Meta::CPAN

## Load the model package
```perl
use BmltClient::Object::AuthenticationError;
```

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**message** | **string** |  | 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/AuthorizationError.md view on Meta::CPAN

## Load the model package
```perl
use BmltClient::Object::AuthorizationError;
```

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**message** | **string** |  | 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/Format.md view on Meta::CPAN

```

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**world_id** | **string** |  | 
**type** | **string** |  | 
**translations** | [**ARRAY[FormatTranslation]**](FormatTranslation.md) |  | 
**id** | **int** |  | 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/FormatAllOf.md view on Meta::CPAN

## Load the model package
```perl
use BmltClient::Object::FormatAllOf;
```

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** |  | [optional] 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/FormatBase.md view on Meta::CPAN

use BmltClient::Object::FormatBase;
```

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**world_id** | **string** |  | [optional] 
**type** | **string** |  | [optional] 
**translations** | [**ARRAY[FormatTranslation]**](FormatTranslation.md) |  | [optional] 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/FormatCreate.md view on Meta::CPAN

use BmltClient::Object::FormatCreate;
```

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**world_id** | **string** |  | [optional] 
**type** | **string** |  | [optional] 
**translations** | [**ARRAY[FormatTranslation]**](FormatTranslation.md) |  | 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/FormatPartialUpdate.md view on Meta::CPAN

use BmltClient::Object::FormatPartialUpdate;
```

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**world_id** | **string** |  | [optional] 
**type** | **string** |  | [optional] 
**translations** | [**ARRAY[FormatTranslation]**](FormatTranslation.md) |  | [optional] 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/FormatTranslation.md view on Meta::CPAN

```

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**key** | **string** |  | 
**name** | **string** |  | 
**description** | **string** |  | 
**language** | **string** |  | 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/FormatUpdate.md view on Meta::CPAN

use BmltClient::Object::FormatUpdate;
```

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**world_id** | **string** |  | [optional] 
**type** | **string** |  | [optional] 
**translations** | [**ARRAY[FormatTranslation]**](FormatTranslation.md) |  | 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/Meeting.md view on Meta::CPAN

**contact_name_2** | **string** |  | [optional] 
**contact_phone_1** | **string** |  | [optional] 
**contact_phone_2** | **string** |  | [optional] 
**contact_email_1** | **string** |  | [optional] 
**contact_email_2** | **string** |  | [optional] 
**bus_lines** | **string** |  | [optional] 
**train_line** | **string** |  | [optional] 
**comments** | **string** |  | [optional] 
**id** | **int** |  | 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/MeetingBase.md view on Meta::CPAN

**contact_name_1** | **string** |  | [optional] 
**contact_name_2** | **string** |  | [optional] 
**contact_phone_1** | **string** |  | [optional] 
**contact_phone_2** | **string** |  | [optional] 
**contact_email_1** | **string** |  | [optional] 
**contact_email_2** | **string** |  | [optional] 
**bus_lines** | **string** |  | [optional] 
**train_line** | **string** |  | [optional] 
**comments** | **string** |  | [optional] 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/MeetingCreate.md view on Meta::CPAN

**contact_name_1** | **string** |  | [optional] 
**contact_name_2** | **string** |  | [optional] 
**contact_phone_1** | **string** |  | [optional] 
**contact_phone_2** | **string** |  | [optional] 
**contact_email_1** | **string** |  | [optional] 
**contact_email_2** | **string** |  | [optional] 
**bus_lines** | **string** |  | [optional] 
**train_line** | **string** |  | [optional] 
**comments** | **string** |  | [optional] 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/MeetingPartialUpdate.md view on Meta::CPAN

**contact_name_1** | **string** |  | [optional] 
**contact_name_2** | **string** |  | [optional] 
**contact_phone_1** | **string** |  | [optional] 
**contact_phone_2** | **string** |  | [optional] 
**contact_email_1** | **string** |  | [optional] 
**contact_email_2** | **string** |  | [optional] 
**bus_lines** | **string** |  | [optional] 
**train_line** | **string** |  | [optional] 
**comments** | **string** |  | [optional] 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/MeetingUpdate.md view on Meta::CPAN

**contact_name_1** | **string** |  | [optional] 
**contact_name_2** | **string** |  | [optional] 
**contact_phone_1** | **string** |  | [optional] 
**contact_phone_2** | **string** |  | [optional] 
**contact_email_1** | **string** |  | [optional] 
**contact_email_2** | **string** |  | [optional] 
**bus_lines** | **string** |  | [optional] 
**train_line** | **string** |  | [optional] 
**comments** | **string** |  | [optional] 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/NotFoundError.md view on Meta::CPAN

## Load the model package
```perl
use BmltClient::Object::NotFoundError;
```

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**message** | **string** |  | 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/RootServerApi.md view on Meta::CPAN


eval {
    $api_instance->auth_logout();
};
if ($@) {
    warn "Exception when calling RootServerApi->auth_logout: $@\n";
}
```

### Parameters
This endpoint does not need any parameter.

### Return type

void (empty response body)

### Authorization

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

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

# **auth_refresh**
> Token auth_refresh()

Revokes and issues a new token

Refresh token.

### Example
```perl

docs/RootServerApi.md view on Meta::CPAN

eval {
    my $result = $api_instance->auth_refresh();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RootServerApi->auth_refresh: $@\n";
}
```

### Parameters
This endpoint does not need any parameter.

### Return type

[**Token**](Token.md)

### Authorization

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

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

# **auth_token**
> Token auth_token(token_credentials => $token_credentials)

Creates a token

Exchange credentials for a new token

### Example
```perl

docs/RootServerApi.md view on Meta::CPAN


### Authorization

No authorization required

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

# **create_format**
> Format create_format(format_create => $format_create)

Creates a format

Creates a format.

### Example
```perl

docs/RootServerApi.md view on Meta::CPAN


### Authorization

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

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

# **create_meeting**
> Meeting create_meeting(meeting_create => $meeting_create)

Creates a meeting

Creates a meeting.

### Example
```perl

docs/RootServerApi.md view on Meta::CPAN


### Authorization

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

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

# **create_service_body**
> ServiceBody create_service_body(service_body_create => $service_body_create)

Creates a service body

Creates a service body.

### Example
```perl

docs/RootServerApi.md view on Meta::CPAN


### Authorization

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

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

# **create_user**
> User create_user(user_create => $user_create)

Creates a user

Creates a user.

### Example
```perl

docs/RootServerApi.md view on Meta::CPAN


### Authorization

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

### 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_format**
> delete_format(format_id => $format_id)

Deletes a format

Deletes a format by id.

### Example
```perl

docs/RootServerApi.md view on Meta::CPAN


### Authorization

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

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

# **delete_meeting**
> delete_meeting(meeting_id => $meeting_id)

Deletes a meeting

Deletes a meeting by id.

### Example
```perl

docs/RootServerApi.md view on Meta::CPAN


### Authorization

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

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

# **delete_service_body**
> delete_service_body(service_body_id => $service_body_id)

Deletes a service body

Deletes a service body by id.

### Example
```perl

docs/RootServerApi.md view on Meta::CPAN


### Authorization

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

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

# **delete_user**
> delete_user(user_id => $user_id)

Deletes a user

Deletes a user by id

### Example
```perl

docs/RootServerApi.md view on Meta::CPAN


### Authorization

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

### 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_format**
> Format get_format(format_id => $format_id)

Retrieves a format

Retrieve a format

### Example
```perl

docs/RootServerApi.md view on Meta::CPAN


### Authorization

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

### 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_formats**
> ARRAY[Format] get_formats()

Retrieves formats

Retrieve formats

### Example
```perl

docs/RootServerApi.md view on Meta::CPAN

eval {
    my $result = $api_instance->get_formats();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RootServerApi->get_formats: $@\n";
}
```

### Parameters
This endpoint does not need any parameter.

### Return type

[**ARRAY[Format]**](Format.md)

### Authorization

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

### 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_meeting**
> Meeting get_meeting(meeting_id => $meeting_id)

Retrieves a meeting

Retrieve a meeting.

### Example
```perl

docs/RootServerApi.md view on Meta::CPAN


### Authorization

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

### 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_meetings**
> ARRAY[Meeting] get_meetings(meeting_ids => $meeting_ids, days => $days, service_body_ids => $service_body_ids, search_string => $search_string)

Retrieves meetings

Retrieve meetings for authenticated user.

### Example
```perl

docs/RootServerApi.md view on Meta::CPAN


### Authorization

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

### 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_service_bodies**
> ARRAY[ServiceBody] get_service_bodies()

Retrieves service bodies

Retrieve service bodies for authenticated user.

### Example
```perl

docs/RootServerApi.md view on Meta::CPAN

eval {
    my $result = $api_instance->get_service_bodies();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RootServerApi->get_service_bodies: $@\n";
}
```

### Parameters
This endpoint does not need any parameter.

### Return type

[**ARRAY[ServiceBody]**](ServiceBody.md)

### Authorization

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

### 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_service_body**
> ServiceBody get_service_body(service_body_id => $service_body_id)

Retrieves a service body

Retrieve a single service body by id.

### Example
```perl

docs/RootServerApi.md view on Meta::CPAN


### Authorization

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

### 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_user**
> User get_user(user_id => $user_id)

Retrieves a single user

Retrieve single user.

### Example
```perl

docs/RootServerApi.md view on Meta::CPAN


### Authorization

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

### 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_users**
> ARRAY[User] get_users()

Retrieves users

Retrieve users for authenticated user.

### Example
```perl

docs/RootServerApi.md view on Meta::CPAN

eval {
    my $result = $api_instance->get_users();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RootServerApi->get_users: $@\n";
}
```

### Parameters
This endpoint does not need any parameter.

### Return type

[**ARRAY[User]**](User.md)

### Authorization

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

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

# **partial_update_user**
> partial_update_user(user_id => $user_id, user_partial_update => $user_partial_update)

Patches a user

Patches a user by id.

### Example
```perl

docs/RootServerApi.md view on Meta::CPAN


### Authorization

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

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

# **patch_format**
> patch_format(format_id => $format_id, format_partial_update => $format_partial_update)

Patches a format

Patches a single format by id.

### Example
```perl

docs/RootServerApi.md view on Meta::CPAN


### Authorization

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

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

# **patch_meeting**
> patch_meeting(meeting_id => $meeting_id, meeting_partial_update => $meeting_partial_update)

Patches a meeting

Patches a meeting by id

### Example
```perl

docs/RootServerApi.md view on Meta::CPAN


### Authorization

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

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

# **patch_service_body**
> patch_service_body(service_body_id => $service_body_id, service_body_partial_update => $service_body_partial_update)

Patches a service body

Patches a single service body by id.

### Example
```perl

docs/RootServerApi.md view on Meta::CPAN


### Authorization

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

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

# **update_format**
> update_format(format_id => $format_id, format_update => $format_update)

Updates a format

Updates a format.

### Example
```perl

docs/RootServerApi.md view on Meta::CPAN


### Authorization

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

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

# **update_meeting**
> update_meeting(meeting_id => $meeting_id, meeting_update => $meeting_update)

Updates a meeting

Updates a meeting.

### Example
```perl

docs/RootServerApi.md view on Meta::CPAN


### Authorization

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

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

# **update_service_body**
> update_service_body(service_body_id => $service_body_id, service_body_update => $service_body_update)

Updates a Service Body

Updates a single service body.

### Example
```perl

docs/RootServerApi.md view on Meta::CPAN


### Authorization

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

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

# **update_user**
> update_user(user_id => $user_id, user_update => $user_update)

Update single user

Updates a user.

### Example
```perl

docs/RootServerApi.md view on Meta::CPAN


### Authorization

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

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

docs/ServiceBody.md view on Meta::CPAN

**description** | **string** |  | 
**type** | **string** |  | 
**admin_user_id** | **int** |  | 
**assigned_user_ids** | **ARRAY[int]** |  | 
**url** | **string** |  | 
**helpline** | **string** |  | 
**email** | **string** |  | 
**world_id** | **string** |  | 
**id** | **int** |  | 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/ServiceBodyBase.md view on Meta::CPAN

**name** | **string** |  | [optional] 
**description** | **string** |  | [optional] 
**type** | **string** |  | [optional] 
**admin_user_id** | **int** |  | [optional] 
**assigned_user_ids** | **ARRAY[int]** |  | [optional] 
**url** | **string** |  | [optional] 
**helpline** | **string** |  | [optional] 
**email** | **string** |  | [optional] 
**world_id** | **string** |  | [optional] 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/ServiceBodyCreate.md view on Meta::CPAN

**name** | **string** |  | 
**description** | **string** |  | 
**type** | **string** |  | 
**admin_user_id** | **int** |  | 
**assigned_user_ids** | **ARRAY[int]** |  | 
**url** | **string** |  | [optional] 
**helpline** | **string** |  | [optional] 
**email** | **string** |  | [optional] 
**world_id** | **string** |  | [optional] 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/ServiceBodyPartialUpdate.md view on Meta::CPAN

**name** | **string** |  | [optional] 
**description** | **string** |  | [optional] 
**type** | **string** |  | [optional] 
**admin_user_id** | **int** |  | [optional] 
**assigned_user_ids** | **ARRAY[int]** |  | [optional] 
**url** | **string** |  | [optional] 
**helpline** | **string** |  | [optional] 
**email** | **string** |  | [optional] 
**world_id** | **string** |  | [optional] 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/ServiceBodyUpdate.md view on Meta::CPAN

**name** | **string** |  | 
**description** | **string** |  | 
**type** | **string** |  | 
**admin_user_id** | **int** |  | 
**assigned_user_ids** | **ARRAY[int]** |  | 
**url** | **string** |  | [optional] 
**helpline** | **string** |  | [optional] 
**email** | **string** |  | [optional] 
**world_id** | **string** |  | [optional] 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/Token.md view on Meta::CPAN

```

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_token** | **string** |  | 
**expires_at** | **int** |  | 
**token_type** | **string** |  | 
**user_id** | **int** |  | 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/TokenCredentials.md view on Meta::CPAN

```perl
use BmltClient::Object::TokenCredentials;
```

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**password** | **string** |  | 
**username** | **string** |  | 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/User.md view on Meta::CPAN

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**username** | **string** |  | 
**type** | **string** |  | 
**display_name** | **string** |  | 
**description** | **string** |  | 
**email** | **string** |  | 
**owner_id** | **string** |  | 
**id** | **int** |  | 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/UserBase.md view on Meta::CPAN

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**username** | **string** |  | [optional] 
**type** | **string** |  | [optional] 
**display_name** | **string** |  | [optional] 
**description** | **string** |  | [optional] 
**email** | **string** |  | [optional] 
**owner_id** | **string** |  | [optional] 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/UserCreate.md view on Meta::CPAN

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**username** | **string** |  | 
**type** | **string** |  | 
**display_name** | **string** |  | 
**description** | **string** |  | [optional] 
**email** | **string** |  | [optional] 
**owner_id** | **string** |  | [optional] 
**password** | **string** |  | 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/UserCreateAllOf.md view on Meta::CPAN

## Load the model package
```perl
use BmltClient::Object::UserCreateAllOf;
```

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**password** | **string** |  | [optional] 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/UserPartialUpdate.md view on Meta::CPAN

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**username** | **string** |  | [optional] 
**type** | **string** |  | [optional] 
**display_name** | **string** |  | [optional] 
**description** | **string** |  | [optional] 
**email** | **string** |  | [optional] 
**owner_id** | **string** |  | [optional] 
**password** | **string** |  | [optional] 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/UserUpdate.md view on Meta::CPAN

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**username** | **string** |  | 
**type** | **string** |  | 
**display_name** | **string** |  | 
**description** | **string** |  | [optional] 
**email** | **string** |  | [optional] 
**owner_id** | **string** |  | [optional] 
**password** | **string** |  | [optional] 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

( run in 0.692 second using v1.01-cache-2.11-cpan-1dc43b0fbd2 )