<commit_before>node effektif api
=================

[![Build Status](https://secure.travis-ci.org/paed01/node-effektif-api.png)](http://travis-ci.org/paed01/node-effektif-api)

Unofficial node [effektif][1] [api][2] wrapper.

# Introduction

The api is auto-generated from the effektif documentation [json-endpoint][3].

# Naming

The module functions are generated from the api-endpoints. The name is composed of the http-operation and the api-endpoint.

|HTTP-verb |function prefix|
|----------|---------------|
| `GET`    | get           |
| `POST`   | create        |
| `PUT`    | update        |
| `DELETE` | delete        |

Examples:

|Operation |function name  |
|----------|---------------|
| `POST /{organizationKey}/tasks` | `createTasks` | 
| `DELETE /{organizationKey}/processes/{processId}/activities/{activityId}` | `deleteProcessActivity` | 

The plural ending is removed if it isn't immediately followed by a path parameter, e.g:

`DELETE /{organizationKey}/processes/{processId}` name is `deleteProcess`.<commit_msg>Coverage badge<commit_after>node effektif api
=================

[![Build Status](https://secure.travis-ci.org/paed01/node-effektif-api.png)](http://travis-ci.org/paed01/node-effektif-api)[![Coverage Status](https://coveralls.io/repos/paed01/node-effektif-api/badge.svg?branch=master)](https://coveralls.io/r/paed01/node-effektif-api?branch=master)

Unofficial node [effektif][1] [api][2] wrapper.

# Introduction

The api is auto-generated from the effektif documentation [json-endpoint][3].

# Naming

The module functions are generated from the api-endpoints. The name is composed of the http-operation and the api-endpoint.

|HTTP-verb |function prefix|
|----------|---------------|
| `GET`    | get           |
| `POST`   | create        |
| `PUT`    | update        |
| `DELETE` | delete        |

Examples:

|Operation |function name  |
|----------|---------------|
| `POST /{organizationKey}/tasks` | `createTasks` | 
| `DELETE /{organizationKey}/processes/{processId}/activities/{activityId}` | `deleteProcessActivity` | 

The plural ending is removed if it isn't immediately followed by a path parameter, e.g:

`DELETE /{organizationKey}/processes/{processId}` name is `deleteProcess`.
{'fraction_non_alphanumeric': 0.19515477792732167, 'fraction_numerical': 0.008075370121130552, 'mean_word_length': 3.3469785575048734, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7400919', 'n_tokens_mistral': 712, 'n_tokens_neox': 696, 'n_words': 161}