endpoint results from the CPAN

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 = {

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

view all matches for this distribution
view release on metacpan - search on metacpan

( run in 2.087 seconds using v1.00-cache-2.02-grep-82fe00e-cpan-4673cadbf75 )