diff --git a/README.md b/README.md index a3dcb29..3ff0444 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ Telematics API to help car companies manage their fleet. * [Requirements](#requirements) * [Getting Started](#getting-started) * [Architecture](#architecture) +* [API Reference](/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/index.md) * [License](#License) * [Contributing](#contributing) diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-a-l-f-a-r-o-m-e-o/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-a-l-f-a-r-o-m-e-o/index.md new file mode 100644 index 0000000..aeace8e --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-a-l-f-a-r-o-m-e-o/index.md @@ -0,0 +1,15 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet.model](../../index.md)/[Brand](../index.md)/[ALFAROMEO](index.md) + +# ALFAROMEO + +[jvm]\ +@SerialName(value = "alfaromeo") + +[ALFAROMEO](index.md) + +## Properties + +| Name | Summary | +|---|---| +| [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-b-m-w/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-b-m-w/index.md new file mode 100644 index 0000000..dddb428 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-b-m-w/index.md @@ -0,0 +1,15 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet.model](../../index.md)/[Brand](../index.md)/[BMW](index.md) + +# BMW + +[jvm]\ +@SerialName(value = "bmw") + +[BMW](index.md) + +## Properties + +| Name | Summary | +|---|---| +| [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-c-i-t-r-o-e-n/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-c-i-t-r-o-e-n/index.md new file mode 100644 index 0000000..db1f61e --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-c-i-t-r-o-e-n/index.md @@ -0,0 +1,15 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet.model](../../index.md)/[Brand](../index.md)/[CITROEN](index.md) + +# CITROEN + +[jvm]\ +@SerialName(value = "citroen") + +[CITROEN](index.md) + +## Properties + +| Name | Summary | +|---|---| +| [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-d-s/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-d-s/index.md new file mode 100644 index 0000000..2f7fb0f --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-d-s/index.md @@ -0,0 +1,15 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet.model](../../index.md)/[Brand](../index.md)/[DS](index.md) + +# DS + +[jvm]\ +@SerialName(value = "ds") + +[DS](index.md) + +## Properties + +| Name | Summary | +|---|---| +| [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-f-i-a-t/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-f-i-a-t/index.md new file mode 100644 index 0000000..59a6f2a --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-f-i-a-t/index.md @@ -0,0 +1,15 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet.model](../../index.md)/[Brand](../index.md)/[FIAT](index.md) + +# FIAT + +[jvm]\ +@SerialName(value = "fiat") + +[FIAT](index.md) + +## Properties + +| Name | Summary | +|---|---| +| [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-f-o-r-d/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-f-o-r-d/index.md new file mode 100644 index 0000000..8ed6287 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-f-o-r-d/index.md @@ -0,0 +1,15 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet.model](../../index.md)/[Brand](../index.md)/[FORD](index.md) + +# FORD + +[jvm]\ +@SerialName(value = "ford") + +[FORD](index.md) + +## Properties + +| Name | Summary | +|---|---| +| [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-j-e-e-p/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-j-e-e-p/index.md new file mode 100644 index 0000000..ea90b14 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-j-e-e-p/index.md @@ -0,0 +1,15 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet.model](../../index.md)/[Brand](../index.md)/[JEEP](index.md) + +# JEEP + +[jvm]\ +@SerialName(value = "jeep") + +[JEEP](index.md) + +## Properties + +| Name | Summary | +|---|---| +| [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-k-i-a/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-k-i-a/index.md new file mode 100644 index 0000000..a0b3934 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-k-i-a/index.md @@ -0,0 +1,15 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet.model](../../index.md)/[Brand](../index.md)/[KIA](index.md) + +# KIA + +[jvm]\ +@SerialName(value = "kia") + +[KIA](index.md) + +## Properties + +| Name | Summary | +|---|---| +| [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-l-e-x-u-s/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-l-e-x-u-s/index.md new file mode 100644 index 0000000..1f12471 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-l-e-x-u-s/index.md @@ -0,0 +1,15 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet.model](../../index.md)/[Brand](../index.md)/[LEXUS](index.md) + +# LEXUS + +[jvm]\ +@SerialName(value = "lexus") + +[LEXUS](index.md) + +## Properties + +| Name | Summary | +|---|---| +| [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-m-a-s-e-r-a-t-i/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-m-a-s-e-r-a-t-i/index.md new file mode 100644 index 0000000..8897010 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-m-a-s-e-r-a-t-i/index.md @@ -0,0 +1,15 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet.model](../../index.md)/[Brand](../index.md)/[MASERATI](index.md) + +# MASERATI + +[jvm]\ +@SerialName(value = "maserati") + +[MASERATI](index.md) + +## Properties + +| Name | Summary | +|---|---| +| [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-m-e-r-c-e-d-e-s_-b-e-n-z/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-m-e-r-c-e-d-e-s_-b-e-n-z/index.md new file mode 100644 index 0000000..bcd1e44 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-m-e-r-c-e-d-e-s_-b-e-n-z/index.md @@ -0,0 +1,15 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet.model](../../index.md)/[Brand](../index.md)/[MERCEDES_BENZ](index.md) + +# MERCEDES_BENZ + +[jvm]\ +@SerialName(value = "mercedes-benz") + +[MERCEDES_BENZ](index.md) + +## Properties + +| Name | Summary | +|---|---| +| [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-m-i-n-i/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-m-i-n-i/index.md new file mode 100644 index 0000000..8715869 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-m-i-n-i/index.md @@ -0,0 +1,15 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet.model](../../index.md)/[Brand](../index.md)/[MINI](index.md) + +# MINI + +[jvm]\ +@SerialName(value = "mini") + +[MINI](index.md) + +## Properties + +| Name | Summary | +|---|---| +| [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-o-p-e-l/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-o-p-e-l/index.md new file mode 100644 index 0000000..a17ea4d --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-o-p-e-l/index.md @@ -0,0 +1,15 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet.model](../../index.md)/[Brand](../index.md)/[OPEL](index.md) + +# OPEL + +[jvm]\ +@SerialName(value = "opel") + +[OPEL](index.md) + +## Properties + +| Name | Summary | +|---|---| +| [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-p-e-u-g-e-o-t/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-p-e-u-g-e-o-t/index.md new file mode 100644 index 0000000..aae7455 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-p-e-u-g-e-o-t/index.md @@ -0,0 +1,15 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet.model](../../index.md)/[Brand](../index.md)/[PEUGEOT](index.md) + +# PEUGEOT + +[jvm]\ +@SerialName(value = "peugeot") + +[PEUGEOT](index.md) + +## Properties + +| Name | Summary | +|---|---| +| [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-p-o-r-s-c-h-e/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-p-o-r-s-c-h-e/index.md new file mode 100644 index 0000000..ddd5092 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-p-o-r-s-c-h-e/index.md @@ -0,0 +1,15 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet.model](../../index.md)/[Brand](../index.md)/[PORSCHE](index.md) + +# PORSCHE + +[jvm]\ +@SerialName(value = "porsche") + +[PORSCHE](index.md) + +## Properties + +| Name | Summary | +|---|---| +| [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-r-e-n-a-u-l-t/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-r-e-n-a-u-l-t/index.md new file mode 100644 index 0000000..f324978 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-r-e-n-a-u-l-t/index.md @@ -0,0 +1,15 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet.model](../../index.md)/[Brand](../index.md)/[RENAULT](index.md) + +# RENAULT + +[jvm]\ +@SerialName(value = "renault") + +[RENAULT](index.md) + +## Properties + +| Name | Summary | +|---|---| +| [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-s-a-n-d-b-o-x/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-s-a-n-d-b-o-x/index.md new file mode 100644 index 0000000..8a52117 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-s-a-n-d-b-o-x/index.md @@ -0,0 +1,15 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet.model](../../index.md)/[Brand](../index.md)/[SANDBOX](index.md) + +# SANDBOX + +[jvm]\ +@SerialName(value = "sandbox") + +[SANDBOX](index.md) + +## Properties + +| Name | Summary | +|---|---| +| [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-t-e-s-l-a/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-t-e-s-l-a/index.md new file mode 100644 index 0000000..ae70418 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-t-e-s-l-a/index.md @@ -0,0 +1,15 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet.model](../../index.md)/[Brand](../index.md)/[TESLA](index.md) + +# TESLA + +[jvm]\ +@SerialName(value = "tesla") + +[TESLA](index.md) + +## Properties + +| Name | Summary | +|---|---| +| [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-t-o-y-o-t-a/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-t-o-y-o-t-a/index.md new file mode 100644 index 0000000..f4c59c0 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-t-o-y-o-t-a/index.md @@ -0,0 +1,15 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet.model](../../index.md)/[Brand](../index.md)/[TOYOTA](index.md) + +# TOYOTA + +[jvm]\ +@SerialName(value = "toyota") + +[TOYOTA](index.md) + +## Properties + +| Name | Summary | +|---|---| +| [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-v-a-u-x-h-a-l-l/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-v-a-u-x-h-a-l-l/index.md new file mode 100644 index 0000000..7731051 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-v-a-u-x-h-a-l-l/index.md @@ -0,0 +1,15 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet.model](../../index.md)/[Brand](../index.md)/[VAUXHALL](index.md) + +# VAUXHALL + +[jvm]\ +@SerialName(value = "vauxhall") + +[VAUXHALL](index.md) + +## Properties + +| Name | Summary | +|---|---| +| [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-v-o-l-v-o_-c-a-r-s/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-v-o-l-v-o_-c-a-r-s/index.md new file mode 100644 index 0000000..e2cc784 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-v-o-l-v-o_-c-a-r-s/index.md @@ -0,0 +1,15 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet.model](../../index.md)/[Brand](../index.md)/[VOLVO_CARS](index.md) + +# VOLVO_CARS + +[jvm]\ +@SerialName(value = "volvo-cars") + +[VOLVO_CARS](index.md) + +## Properties + +| Name | Summary | +|---|---| +| [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/entries.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/entries.md new file mode 100644 index 0000000..d21b7af --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/entries.md @@ -0,0 +1,10 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet.model](../index.md)/[Brand](index.md)/[entries](entries.md) + +# entries + +[jvm]\ +val [entries](entries.md): [EnumEntries](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.enums/-enum-entries/index.html)<[Brand](index.md)> + +Returns a representation of an immutable list of all enum entries, in the order they're declared. + +This method may be used to iterate over the enum entries. diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/index.md new file mode 100644 index 0000000..fa5d945 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/index.md @@ -0,0 +1,49 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet.model](../index.md)/[Brand](index.md) + +# Brand + +[jvm]\ +@Serializable + +enum [Brand](index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[Brand](index.md)> + +## Entries + +| | | +|---|---| +| [BMW](-b-m-w/index.md) | [jvm]
@SerialName(value = "bmw")
[BMW](-b-m-w/index.md) | +| [CITROEN](-c-i-t-r-o-e-n/index.md) | [jvm]
@SerialName(value = "citroen")
[CITROEN](-c-i-t-r-o-e-n/index.md) | +| [DS](-d-s/index.md) | [jvm]
@SerialName(value = "ds")
[DS](-d-s/index.md) | +| [MERCEDES_BENZ](-m-e-r-c-e-d-e-s_-b-e-n-z/index.md) | [jvm]
@SerialName(value = "mercedes-benz")
[MERCEDES_BENZ](-m-e-r-c-e-d-e-s_-b-e-n-z/index.md) | +| [MINI](-m-i-n-i/index.md) | [jvm]
@SerialName(value = "mini")
[MINI](-m-i-n-i/index.md) | +| [OPEL](-o-p-e-l/index.md) | [jvm]
@SerialName(value = "opel")
[OPEL](-o-p-e-l/index.md) | +| [PEUGEOT](-p-e-u-g-e-o-t/index.md) | [jvm]
@SerialName(value = "peugeot")
[PEUGEOT](-p-e-u-g-e-o-t/index.md) | +| [VAUXHALL](-v-a-u-x-h-a-l-l/index.md) | [jvm]
@SerialName(value = "vauxhall")
[VAUXHALL](-v-a-u-x-h-a-l-l/index.md) | +| [JEEP](-j-e-e-p/index.md) | [jvm]
@SerialName(value = "jeep")
[JEEP](-j-e-e-p/index.md) | +| [FIAT](-f-i-a-t/index.md) | [jvm]
@SerialName(value = "fiat")
[FIAT](-f-i-a-t/index.md) | +| [ALFAROMEO](-a-l-f-a-r-o-m-e-o/index.md) | [jvm]
@SerialName(value = "alfaromeo")
[ALFAROMEO](-a-l-f-a-r-o-m-e-o/index.md) | +| [FORD](-f-o-r-d/index.md) | [jvm]
@SerialName(value = "ford")
[FORD](-f-o-r-d/index.md) | +| [RENAULT](-r-e-n-a-u-l-t/index.md) | [jvm]
@SerialName(value = "renault")
[RENAULT](-r-e-n-a-u-l-t/index.md) | +| [TOYOTA](-t-o-y-o-t-a/index.md) | [jvm]
@SerialName(value = "toyota")
[TOYOTA](-t-o-y-o-t-a/index.md) | +| [LEXUS](-l-e-x-u-s/index.md) | [jvm]
@SerialName(value = "lexus")
[LEXUS](-l-e-x-u-s/index.md) | +| [PORSCHE](-p-o-r-s-c-h-e/index.md) | [jvm]
@SerialName(value = "porsche")
[PORSCHE](-p-o-r-s-c-h-e/index.md) | +| [MASERATI](-m-a-s-e-r-a-t-i/index.md) | [jvm]
@SerialName(value = "maserati")
[MASERATI](-m-a-s-e-r-a-t-i/index.md) | +| [KIA](-k-i-a/index.md) | [jvm]
@SerialName(value = "kia")
[KIA](-k-i-a/index.md) | +| [TESLA](-t-e-s-l-a/index.md) | [jvm]
@SerialName(value = "tesla")
[TESLA](-t-e-s-l-a/index.md) | +| [VOLVO_CARS](-v-o-l-v-o_-c-a-r-s/index.md) | [jvm]
@SerialName(value = "volvo-cars")
[VOLVO_CARS](-v-o-l-v-o_-c-a-r-s/index.md) | +| [SANDBOX](-s-a-n-d-b-o-x/index.md) | [jvm]
@SerialName(value = "sandbox")
[SANDBOX](-s-a-n-d-b-o-x/index.md) | + +## Properties + +| Name | Summary | +|---|---| +| [entries](entries.md) | [jvm]
val [entries](entries.md): [EnumEntries](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.enums/-enum-entries/index.html)<[Brand](index.md)>
Returns a representation of an immutable list of all enum entries, in the order they're declared. | +| [name](../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | + +## Functions + +| Name | Summary | +|---|---| +| [valueOf](value-of.md) | [jvm]
fun [valueOf](value-of.md)(value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [Brand](index.md)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) | +| [values](values.md) | [jvm]
fun [values](values.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Brand](index.md)>
Returns an array containing the constants of this enum type, in the order they're declared. | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/value-of.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/value-of.md new file mode 100644 index 0000000..9f99d11 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/value-of.md @@ -0,0 +1,14 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet.model](../index.md)/[Brand](index.md)/[valueOf](value-of.md) + +# valueOf + +[jvm]\ +fun [valueOf](value-of.md)(value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [Brand](index.md) + +Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) + +#### Throws + +| | | +|---|---| +| [IllegalArgumentException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html) | if this enum type has no constant with the specified name | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/values.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/values.md new file mode 100644 index 0000000..a6770d0 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/values.md @@ -0,0 +1,10 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet.model](../index.md)/[Brand](index.md)/[values](values.md) + +# values + +[jvm]\ +fun [values](values.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Brand](index.md)> + +Returns an array containing the constants of this enum type, in the order they're declared. + +This method may be used to iterate over the constants. diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-change-log-item/-change-log-item.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-change-log-item/-change-log-item.md new file mode 100644 index 0000000..c3f86f7 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-change-log-item/-change-log-item.md @@ -0,0 +1,6 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet.model](../index.md)/[ChangeLogItem](index.md)/[ChangeLogItem](-change-log-item.md) + +# ChangeLogItem + +[jvm]\ +constructor(status: [ClearanceStatus.Status](../-clearance-status/-status/index.md), timestamp: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-change-log-item/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-change-log-item/index.md new file mode 100644 index 0000000..fb4321f --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-change-log-item/index.md @@ -0,0 +1,21 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet.model](../index.md)/[ChangeLogItem](index.md) + +# ChangeLogItem + +[jvm]\ +@Serializable + +data class [ChangeLogItem](index.md)(val status: [ClearanceStatus.Status](../-clearance-status/-status/index.md), val timestamp: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) + +## Constructors + +| | | +|---|---| +| [ChangeLogItem](-change-log-item.md) | [jvm]
constructor(status: [ClearanceStatus.Status](../-clearance-status/-status/index.md), timestamp: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) | + +## Properties + +| Name | Summary | +|---|---| +| [status](status.md) | [jvm]
val [status](status.md): [ClearanceStatus.Status](../-clearance-status/-status/index.md) | +| [timestamp](timestamp.md) | [jvm]
val [timestamp](timestamp.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-change-log-item/status.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-change-log-item/status.md new file mode 100644 index 0000000..a5448d6 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-change-log-item/status.md @@ -0,0 +1,6 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet.model](../index.md)/[ChangeLogItem](index.md)/[status](status.md) + +# status + +[jvm]\ +val [status](status.md): [ClearanceStatus.Status](../-clearance-status/-status/index.md) diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-change-log-item/timestamp.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-change-log-item/timestamp.md new file mode 100644 index 0000000..3e670f1 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-change-log-item/timestamp.md @@ -0,0 +1,6 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet.model](../index.md)/[ChangeLogItem](index.md)/[timestamp](timestamp.md) + +# timestamp + +[jvm]\ +val [timestamp](timestamp.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-clearance-status.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-clearance-status.md new file mode 100644 index 0000000..cc21666 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-clearance-status.md @@ -0,0 +1,6 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet.model](../index.md)/[ClearanceStatus](index.md)/[ClearanceStatus](-clearance-status.md) + +# ClearanceStatus + +[jvm]\ +constructor(vin: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), status: [ClearanceStatus.Status](-status/index.md), brand: [Brand](../-brand/index.md)? = null, changelog: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[ChangeLogItem](../-change-log-item/index.md)> = emptyList()) diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/-a-p-p-r-o-v-e-d/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/-a-p-p-r-o-v-e-d/index.md new file mode 100644 index 0000000..1dcb500 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/-a-p-p-r-o-v-e-d/index.md @@ -0,0 +1,15 @@ +//[hmkit-fleet](../../../../../index.md)/[com.highmobility.hmkitfleet.model](../../../index.md)/[ClearanceStatus](../../index.md)/[Status](../index.md)/[APPROVED](index.md) + +# APPROVED + +[jvm]\ +@SerialName(value = "approved") + +[APPROVED](index.md) + +## Properties + +| Name | Summary | +|---|---| +| [name](../../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/-c-a-n-c-e-l-e-d/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/-c-a-n-c-e-l-e-d/index.md new file mode 100644 index 0000000..3825998 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/-c-a-n-c-e-l-e-d/index.md @@ -0,0 +1,15 @@ +//[hmkit-fleet](../../../../../index.md)/[com.highmobility.hmkitfleet.model](../../../index.md)/[ClearanceStatus](../../index.md)/[Status](../index.md)/[CANCELED](index.md) + +# CANCELED + +[jvm]\ +@SerialName(value = "canceled") + +[CANCELED](index.md) + +## Properties + +| Name | Summary | +|---|---| +| [name](../../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/-c-a-n-c-e-l-i-n-g/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/-c-a-n-c-e-l-i-n-g/index.md new file mode 100644 index 0000000..80fcce5 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/-c-a-n-c-e-l-i-n-g/index.md @@ -0,0 +1,15 @@ +//[hmkit-fleet](../../../../../index.md)/[com.highmobility.hmkitfleet.model](../../../index.md)/[ClearanceStatus](../../index.md)/[Status](../index.md)/[CANCELING](index.md) + +# CANCELING + +[jvm]\ +@SerialName(value = "canceling") + +[CANCELING](index.md) + +## Properties + +| Name | Summary | +|---|---| +| [name](../../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/-e-r-r-o-r/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/-e-r-r-o-r/index.md new file mode 100644 index 0000000..9027f5f --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/-e-r-r-o-r/index.md @@ -0,0 +1,15 @@ +//[hmkit-fleet](../../../../../index.md)/[com.highmobility.hmkitfleet.model](../../../index.md)/[ClearanceStatus](../../index.md)/[Status](../index.md)/[ERROR](index.md) + +# ERROR + +[jvm]\ +@SerialName(value = "error") + +[ERROR](index.md) + +## Properties + +| Name | Summary | +|---|---| +| [name](../../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/-p-e-n-d-i-n-g/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/-p-e-n-d-i-n-g/index.md new file mode 100644 index 0000000..33ac1ba --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/-p-e-n-d-i-n-g/index.md @@ -0,0 +1,15 @@ +//[hmkit-fleet](../../../../../index.md)/[com.highmobility.hmkitfleet.model](../../../index.md)/[ClearanceStatus](../../index.md)/[Status](../index.md)/[PENDING](index.md) + +# PENDING + +[jvm]\ +@SerialName(value = "pending") + +[PENDING](index.md) + +## Properties + +| Name | Summary | +|---|---| +| [name](../../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/-r-e-j-e-c-t-e-d/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/-r-e-j-e-c-t-e-d/index.md new file mode 100644 index 0000000..6cc3a6b --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/-r-e-j-e-c-t-e-d/index.md @@ -0,0 +1,15 @@ +//[hmkit-fleet](../../../../../index.md)/[com.highmobility.hmkitfleet.model](../../../index.md)/[ClearanceStatus](../../index.md)/[Status](../index.md)/[REJECTED](index.md) + +# REJECTED + +[jvm]\ +@SerialName(value = "rejected") + +[REJECTED](index.md) + +## Properties + +| Name | Summary | +|---|---| +| [name](../../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/-r-e-v-o-k-e-d/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/-r-e-v-o-k-e-d/index.md new file mode 100644 index 0000000..6c4804d --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/-r-e-v-o-k-e-d/index.md @@ -0,0 +1,15 @@ +//[hmkit-fleet](../../../../../index.md)/[com.highmobility.hmkitfleet.model](../../../index.md)/[ClearanceStatus](../../index.md)/[Status](../index.md)/[REVOKED](index.md) + +# REVOKED + +[jvm]\ +@SerialName(value = "revoked") + +[REVOKED](index.md) + +## Properties + +| Name | Summary | +|---|---| +| [name](../../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/-r-e-v-o-k-i-n-g/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/-r-e-v-o-k-i-n-g/index.md new file mode 100644 index 0000000..a3c9cec --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/-r-e-v-o-k-i-n-g/index.md @@ -0,0 +1,15 @@ +//[hmkit-fleet](../../../../../index.md)/[com.highmobility.hmkitfleet.model](../../../index.md)/[ClearanceStatus](../../index.md)/[Status](../index.md)/[REVOKING](index.md) + +# REVOKING + +[jvm]\ +@SerialName(value = "revoking") + +[REVOKING](index.md) + +## Properties + +| Name | Summary | +|---|---| +| [name](../../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/entries.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/entries.md new file mode 100644 index 0000000..fb3656b --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/entries.md @@ -0,0 +1,10 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet.model](../../index.md)/[ClearanceStatus](../index.md)/[Status](index.md)/[entries](entries.md) + +# entries + +[jvm]\ +val [entries](entries.md): [EnumEntries](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.enums/-enum-entries/index.html)<[ClearanceStatus.Status](index.md)> + +Returns a representation of an immutable list of all enum entries, in the order they're declared. + +This method may be used to iterate over the enum entries. diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/index.md new file mode 100644 index 0000000..8c76a19 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/index.md @@ -0,0 +1,36 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet.model](../../index.md)/[ClearanceStatus](../index.md)/[Status](index.md) + +# Status + +[jvm]\ +@Serializable + +enum [Status](index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[ClearanceStatus.Status](index.md)> + +## Entries + +| | | +|---|---| +| [APPROVED](-a-p-p-r-o-v-e-d/index.md) | [jvm]
@SerialName(value = "approved")
[APPROVED](-a-p-p-r-o-v-e-d/index.md) | +| [PENDING](-p-e-n-d-i-n-g/index.md) | [jvm]
@SerialName(value = "pending")
[PENDING](-p-e-n-d-i-n-g/index.md) | +| [ERROR](-e-r-r-o-r/index.md) | [jvm]
@SerialName(value = "error")
[ERROR](-e-r-r-o-r/index.md) | +| [REVOKING](-r-e-v-o-k-i-n-g/index.md) | [jvm]
@SerialName(value = "revoking")
[REVOKING](-r-e-v-o-k-i-n-g/index.md) | +| [REVOKED](-r-e-v-o-k-e-d/index.md) | [jvm]
@SerialName(value = "revoked")
[REVOKED](-r-e-v-o-k-e-d/index.md) | +| [REJECTED](-r-e-j-e-c-t-e-d/index.md) | [jvm]
@SerialName(value = "rejected")
[REJECTED](-r-e-j-e-c-t-e-d/index.md) | +| [CANCELING](-c-a-n-c-e-l-i-n-g/index.md) | [jvm]
@SerialName(value = "canceling")
[CANCELING](-c-a-n-c-e-l-i-n-g/index.md) | +| [CANCELED](-c-a-n-c-e-l-e-d/index.md) | [jvm]
@SerialName(value = "canceled")
[CANCELED](-c-a-n-c-e-l-e-d/index.md) | + +## Properties + +| Name | Summary | +|---|---| +| [entries](entries.md) | [jvm]
val [entries](entries.md): [EnumEntries](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.enums/-enum-entries/index.html)<[ClearanceStatus.Status](index.md)>
Returns a representation of an immutable list of all enum entries, in the order they're declared. | +| [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | + +## Functions + +| Name | Summary | +|---|---| +| [valueOf](value-of.md) | [jvm]
fun [valueOf](value-of.md)(value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [ClearanceStatus.Status](index.md)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) | +| [values](values.md) | [jvm]
fun [values](values.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[ClearanceStatus.Status](index.md)>
Returns an array containing the constants of this enum type, in the order they're declared. | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/value-of.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/value-of.md new file mode 100644 index 0000000..d3332b4 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/value-of.md @@ -0,0 +1,14 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet.model](../../index.md)/[ClearanceStatus](../index.md)/[Status](index.md)/[valueOf](value-of.md) + +# valueOf + +[jvm]\ +fun [valueOf](value-of.md)(value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [ClearanceStatus.Status](index.md) + +Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) + +#### Throws + +| | | +|---|---| +| [IllegalArgumentException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html) | if this enum type has no constant with the specified name | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/values.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/values.md new file mode 100644 index 0000000..1c3a019 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/values.md @@ -0,0 +1,10 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet.model](../../index.md)/[ClearanceStatus](../index.md)/[Status](index.md)/[values](values.md) + +# values + +[jvm]\ +fun [values](values.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[ClearanceStatus.Status](index.md)> + +Returns an array containing the constants of this enum type, in the order they're declared. + +This method may be used to iterate over the constants. diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/brand.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/brand.md new file mode 100644 index 0000000..52bf357 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/brand.md @@ -0,0 +1,6 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet.model](../index.md)/[ClearanceStatus](index.md)/[brand](brand.md) + +# brand + +[jvm]\ +val [brand](brand.md): [Brand](../-brand/index.md)? = null diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/changelog.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/changelog.md new file mode 100644 index 0000000..302b8a9 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/changelog.md @@ -0,0 +1,6 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet.model](../index.md)/[ClearanceStatus](index.md)/[changelog](changelog.md) + +# changelog + +[jvm]\ +val [changelog](changelog.md): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[ChangeLogItem](../-change-log-item/index.md)> diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/index.md new file mode 100644 index 0000000..bb00d70 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/index.md @@ -0,0 +1,29 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet.model](../index.md)/[ClearanceStatus](index.md) + +# ClearanceStatus + +[jvm]\ +@Serializable + +data class [ClearanceStatus](index.md)(val vin: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), val status: [ClearanceStatus.Status](-status/index.md), val brand: [Brand](../-brand/index.md)? = null, val changelog: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[ChangeLogItem](../-change-log-item/index.md)> = emptyList()) + +## Constructors + +| | | +|---|---| +| [ClearanceStatus](-clearance-status.md) | [jvm]
constructor(vin: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), status: [ClearanceStatus.Status](-status/index.md), brand: [Brand](../-brand/index.md)? = null, changelog: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[ChangeLogItem](../-change-log-item/index.md)> = emptyList()) | + +## Types + +| Name | Summary | +|---|---| +| [Status](-status/index.md) | [jvm]
@Serializable
enum [Status](-status/index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[ClearanceStatus.Status](-status/index.md)> | + +## Properties + +| Name | Summary | +|---|---| +| [brand](brand.md) | [jvm]
val [brand](brand.md): [Brand](../-brand/index.md)? = null | +| [changelog](changelog.md) | [jvm]
val [changelog](changelog.md): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[ChangeLogItem](../-change-log-item/index.md)> | +| [status](status.md) | [jvm]
val [status](status.md): [ClearanceStatus.Status](-status/index.md) | +| [vin](vin.md) | [jvm]
val [vin](vin.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/status.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/status.md new file mode 100644 index 0000000..a493bb1 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/status.md @@ -0,0 +1,6 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet.model](../index.md)/[ClearanceStatus](index.md)/[status](status.md) + +# status + +[jvm]\ +val [status](status.md): [ClearanceStatus.Status](-status/index.md) diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/vin.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/vin.md new file mode 100644 index 0000000..e5e950b --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/vin.md @@ -0,0 +1,6 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet.model](../index.md)/[ClearanceStatus](index.md)/[vin](vin.md) + +# vin + +[jvm]\ +val [vin](vin.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-control-measure/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-control-measure/index.md new file mode 100644 index 0000000..20ff4de --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-control-measure/index.md @@ -0,0 +1,13 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet.model](../index.md)/[ControlMeasure](index.md) + +# ControlMeasure + +@Serializable + +sealed class [ControlMeasure](index.md) + +#### Inheritors + +| | +|---| +| [Odometer](../-odometer/index.md) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-connectivity-status/-a-c-t-i-v-a-t-e-d/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-connectivity-status/-a-c-t-i-v-a-t-e-d/index.md new file mode 100644 index 0000000..7ded3b2 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-connectivity-status/-a-c-t-i-v-a-t-e-d/index.md @@ -0,0 +1,15 @@ +//[hmkit-fleet](../../../../../index.md)/[com.highmobility.hmkitfleet.model](../../../index.md)/[EligibilityStatus](../../index.md)/[ConnectivityStatus](../index.md)/[ACTIVATED](index.md) + +# ACTIVATED + +[jvm]\ +@SerialName(value = "activated") + +[ACTIVATED](index.md) + +## Properties + +| Name | Summary | +|---|---| +| [name](../-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-connectivity-status/-d-e-a-c-t-i-v-a-t-e-d/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-connectivity-status/-d-e-a-c-t-i-v-a-t-e-d/index.md new file mode 100644 index 0000000..ecd9e2c --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-connectivity-status/-d-e-a-c-t-i-v-a-t-e-d/index.md @@ -0,0 +1,15 @@ +//[hmkit-fleet](../../../../../index.md)/[com.highmobility.hmkitfleet.model](../../../index.md)/[EligibilityStatus](../../index.md)/[ConnectivityStatus](../index.md)/[DEACTIVATED](index.md) + +# DEACTIVATED + +[jvm]\ +@SerialName(value = "deactivated") + +[DEACTIVATED](index.md) + +## Properties + +| Name | Summary | +|---|---| +| [name](../-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md new file mode 100644 index 0000000..1e89a02 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md @@ -0,0 +1,15 @@ +//[hmkit-fleet](../../../../../index.md)/[com.highmobility.hmkitfleet.model](../../../index.md)/[EligibilityStatus](../../index.md)/[ConnectivityStatus](../index.md)/[UNKNOWN](index.md) + +# UNKNOWN + +[jvm]\ +@SerialName(value = "unknown") + +[UNKNOWN](index.md) + +## Properties + +| Name | Summary | +|---|---| +| [name](index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-connectivity-status/entries.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-connectivity-status/entries.md new file mode 100644 index 0000000..a685420 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-connectivity-status/entries.md @@ -0,0 +1,10 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet.model](../../index.md)/[EligibilityStatus](../index.md)/[ConnectivityStatus](index.md)/[entries](entries.md) + +# entries + +[jvm]\ +val [entries](entries.md): [EnumEntries](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.enums/-enum-entries/index.html)<[EligibilityStatus.ConnectivityStatus](index.md)> + +Returns a representation of an immutable list of all enum entries, in the order they're declared. + +This method may be used to iterate over the enum entries. diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-connectivity-status/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-connectivity-status/index.md new file mode 100644 index 0000000..f07b5eb --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-connectivity-status/index.md @@ -0,0 +1,31 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet.model](../../index.md)/[EligibilityStatus](../index.md)/[ConnectivityStatus](index.md) + +# ConnectivityStatus + +[jvm]\ +@Serializable + +enum [ConnectivityStatus](index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[EligibilityStatus.ConnectivityStatus](index.md)> + +## Entries + +| | | +|---|---| +| [ACTIVATED](-a-c-t-i-v-a-t-e-d/index.md) | [jvm]
@SerialName(value = "activated")
[ACTIVATED](-a-c-t-i-v-a-t-e-d/index.md) | +| [DEACTIVATED](-d-e-a-c-t-i-v-a-t-e-d/index.md) | [jvm]
@SerialName(value = "deactivated")
[DEACTIVATED](-d-e-a-c-t-i-v-a-t-e-d/index.md) | +| [UNKNOWN](-u-n-k-n-o-w-n/index.md) | [jvm]
@SerialName(value = "unknown")
[UNKNOWN](-u-n-k-n-o-w-n/index.md) | + +## Properties + +| Name | Summary | +|---|---| +| [entries](entries.md) | [jvm]
val [entries](entries.md): [EnumEntries](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.enums/-enum-entries/index.html)<[EligibilityStatus.ConnectivityStatus](index.md)>
Returns a representation of an immutable list of all enum entries, in the order they're declared. | +| [name](-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | + +## Functions + +| Name | Summary | +|---|---| +| [valueOf](value-of.md) | [jvm]
fun [valueOf](value-of.md)(value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [EligibilityStatus.ConnectivityStatus](index.md)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) | +| [values](values.md) | [jvm]
fun [values](values.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[EligibilityStatus.ConnectivityStatus](index.md)>
Returns an array containing the constants of this enum type, in the order they're declared. | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-connectivity-status/value-of.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-connectivity-status/value-of.md new file mode 100644 index 0000000..fba7436 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-connectivity-status/value-of.md @@ -0,0 +1,14 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet.model](../../index.md)/[EligibilityStatus](../index.md)/[ConnectivityStatus](index.md)/[valueOf](value-of.md) + +# valueOf + +[jvm]\ +fun [valueOf](value-of.md)(value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [EligibilityStatus.ConnectivityStatus](index.md) + +Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) + +#### Throws + +| | | +|---|---| +| [IllegalArgumentException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html) | if this enum type has no constant with the specified name | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-connectivity-status/values.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-connectivity-status/values.md new file mode 100644 index 0000000..90137e8 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-connectivity-status/values.md @@ -0,0 +1,10 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet.model](../../index.md)/[EligibilityStatus](../index.md)/[ConnectivityStatus](index.md)/[values](values.md) + +# values + +[jvm]\ +fun [values](values.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[EligibilityStatus.ConnectivityStatus](index.md)> + +Returns an array containing the constants of this enum type, in the order they're declared. + +This method may be used to iterate over the constants. diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-data-delivery/-p-u-l-l/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-data-delivery/-p-u-l-l/index.md new file mode 100644 index 0000000..41ad37f --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-data-delivery/-p-u-l-l/index.md @@ -0,0 +1,15 @@ +//[hmkit-fleet](../../../../../index.md)/[com.highmobility.hmkitfleet.model](../../../index.md)/[EligibilityStatus](../../index.md)/[DataDelivery](../index.md)/[PULL](index.md) + +# PULL + +[jvm]\ +@SerialName(value = "pull") + +[PULL](index.md) + +## Properties + +| Name | Summary | +|---|---| +| [name](../../-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../../-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../../-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-data-delivery/-p-u-s-h/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-data-delivery/-p-u-s-h/index.md new file mode 100644 index 0000000..1ddf1f1 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-data-delivery/-p-u-s-h/index.md @@ -0,0 +1,15 @@ +//[hmkit-fleet](../../../../../index.md)/[com.highmobility.hmkitfleet.model](../../../index.md)/[EligibilityStatus](../../index.md)/[DataDelivery](../index.md)/[PUSH](index.md) + +# PUSH + +[jvm]\ +@SerialName(value = "push") + +[PUSH](index.md) + +## Properties + +| Name | Summary | +|---|---| +| [name](../../-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../../-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../../-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-data-delivery/entries.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-data-delivery/entries.md new file mode 100644 index 0000000..2acfc5f --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-data-delivery/entries.md @@ -0,0 +1,10 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet.model](../../index.md)/[EligibilityStatus](../index.md)/[DataDelivery](index.md)/[entries](entries.md) + +# entries + +[jvm]\ +val [entries](entries.md): [EnumEntries](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.enums/-enum-entries/index.html)<[EligibilityStatus.DataDelivery](index.md)> + +Returns a representation of an immutable list of all enum entries, in the order they're declared. + +This method may be used to iterate over the enum entries. diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-data-delivery/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-data-delivery/index.md new file mode 100644 index 0000000..d9e0401 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-data-delivery/index.md @@ -0,0 +1,30 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet.model](../../index.md)/[EligibilityStatus](../index.md)/[DataDelivery](index.md) + +# DataDelivery + +[jvm]\ +@Serializable + +enum [DataDelivery](index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[EligibilityStatus.DataDelivery](index.md)> + +## Entries + +| | | +|---|---| +| [PULL](-p-u-l-l/index.md) | [jvm]
@SerialName(value = "pull")
[PULL](-p-u-l-l/index.md) | +| [PUSH](-p-u-s-h/index.md) | [jvm]
@SerialName(value = "push")
[PUSH](-p-u-s-h/index.md) | + +## Properties + +| Name | Summary | +|---|---| +| [entries](entries.md) | [jvm]
val [entries](entries.md): [EnumEntries](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.enums/-enum-entries/index.html)<[EligibilityStatus.DataDelivery](index.md)>
Returns a representation of an immutable list of all enum entries, in the order they're declared. | +| [name](../-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | + +## Functions + +| Name | Summary | +|---|---| +| [valueOf](value-of.md) | [jvm]
fun [valueOf](value-of.md)(value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [EligibilityStatus.DataDelivery](index.md)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) | +| [values](values.md) | [jvm]
fun [values](values.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[EligibilityStatus.DataDelivery](index.md)>
Returns an array containing the constants of this enum type, in the order they're declared. | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-data-delivery/value-of.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-data-delivery/value-of.md new file mode 100644 index 0000000..3b334a6 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-data-delivery/value-of.md @@ -0,0 +1,14 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet.model](../../index.md)/[EligibilityStatus](../index.md)/[DataDelivery](index.md)/[valueOf](value-of.md) + +# valueOf + +[jvm]\ +fun [valueOf](value-of.md)(value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [EligibilityStatus.DataDelivery](index.md) + +Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) + +#### Throws + +| | | +|---|---| +| [IllegalArgumentException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html) | if this enum type has no constant with the specified name | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-data-delivery/values.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-data-delivery/values.md new file mode 100644 index 0000000..906ebb8 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-data-delivery/values.md @@ -0,0 +1,10 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet.model](../../index.md)/[EligibilityStatus](../index.md)/[DataDelivery](index.md)/[values](values.md) + +# values + +[jvm]\ +fun [values](values.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[EligibilityStatus.DataDelivery](index.md)> + +Returns an array containing the constants of this enum type, in the order they're declared. + +This method may be used to iterate over the constants. diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-eligibility-status.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-eligibility-status.md new file mode 100644 index 0000000..bf062cc --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-eligibility-status.md @@ -0,0 +1,6 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet.model](../index.md)/[EligibilityStatus](index.md)/[EligibilityStatus](-eligibility-status.md) + +# EligibilityStatus + +[jvm]\ +constructor(vin: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), eligible: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), dataDelivery: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[EligibilityStatus.DataDelivery](-data-delivery/index.md)> = emptyList(), connectivityStatus: [EligibilityStatus.ConnectivityStatus](-connectivity-status/index.md)? = null, primaryUserAssigned: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)? = null) diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/connectivity-status.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/connectivity-status.md new file mode 100644 index 0000000..84ba1b3 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/connectivity-status.md @@ -0,0 +1,9 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet.model](../index.md)/[EligibilityStatus](index.md)/[connectivityStatus](connectivity-status.md) + +# connectivityStatus + +[jvm]\ + +@SerialName(value = "connectivity_status") + +val [connectivityStatus](connectivity-status.md): [EligibilityStatus.ConnectivityStatus](-connectivity-status/index.md)? = null diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/data-delivery.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/data-delivery.md new file mode 100644 index 0000000..ad309fa --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/data-delivery.md @@ -0,0 +1,9 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet.model](../index.md)/[EligibilityStatus](index.md)/[dataDelivery](data-delivery.md) + +# dataDelivery + +[jvm]\ + +@SerialName(value = "data_delivery") + +val [dataDelivery](data-delivery.md): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[EligibilityStatus.DataDelivery](-data-delivery/index.md)> diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/eligible.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/eligible.md new file mode 100644 index 0000000..daabb86 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/eligible.md @@ -0,0 +1,6 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet.model](../index.md)/[EligibilityStatus](index.md)/[eligible](eligible.md) + +# eligible + +[jvm]\ +val [eligible](eligible.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/index.md new file mode 100644 index 0000000..c649c3c --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/index.md @@ -0,0 +1,31 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet.model](../index.md)/[EligibilityStatus](index.md) + +# EligibilityStatus + +[jvm]\ +@Serializable + +data class [EligibilityStatus](index.md)(val vin: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), val eligible: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), val dataDelivery: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[EligibilityStatus.DataDelivery](-data-delivery/index.md)> = emptyList(), val connectivityStatus: [EligibilityStatus.ConnectivityStatus](-connectivity-status/index.md)? = null, val primaryUserAssigned: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)? = null) + +## Constructors + +| | | +|---|---| +| [EligibilityStatus](-eligibility-status.md) | [jvm]
constructor(vin: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), eligible: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), dataDelivery: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[EligibilityStatus.DataDelivery](-data-delivery/index.md)> = emptyList(), connectivityStatus: [EligibilityStatus.ConnectivityStatus](-connectivity-status/index.md)? = null, primaryUserAssigned: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)? = null) | + +## Types + +| Name | Summary | +|---|---| +| [ConnectivityStatus](-connectivity-status/index.md) | [jvm]
@Serializable
enum [ConnectivityStatus](-connectivity-status/index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[EligibilityStatus.ConnectivityStatus](-connectivity-status/index.md)> | +| [DataDelivery](-data-delivery/index.md) | [jvm]
@Serializable
enum [DataDelivery](-data-delivery/index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[EligibilityStatus.DataDelivery](-data-delivery/index.md)> | + +## Properties + +| Name | Summary | +|---|---| +| [connectivityStatus](connectivity-status.md) | [jvm]
@SerialName(value = "connectivity_status")
val [connectivityStatus](connectivity-status.md): [EligibilityStatus.ConnectivityStatus](-connectivity-status/index.md)? = null | +| [dataDelivery](data-delivery.md) | [jvm]
@SerialName(value = "data_delivery")
val [dataDelivery](data-delivery.md): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[EligibilityStatus.DataDelivery](-data-delivery/index.md)> | +| [eligible](eligible.md) | [jvm]
val [eligible](eligible.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [primaryUserAssigned](primary-user-assigned.md) | [jvm]
@SerialName(value = "primary_user_assigned")
val [primaryUserAssigned](primary-user-assigned.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)? = null | +| [vin](vin.md) | [jvm]
val [vin](vin.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/primary-user-assigned.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/primary-user-assigned.md new file mode 100644 index 0000000..522780c --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/primary-user-assigned.md @@ -0,0 +1,9 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet.model](../index.md)/[EligibilityStatus](index.md)/[primaryUserAssigned](primary-user-assigned.md) + +# primaryUserAssigned + +[jvm]\ + +@SerialName(value = "primary_user_assigned") + +val [primaryUserAssigned](primary-user-assigned.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)? = null diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/vin.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/vin.md new file mode 100644 index 0000000..5f7351a --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/vin.md @@ -0,0 +1,6 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet.model](../index.md)/[EligibilityStatus](index.md)/[vin](vin.md) + +# vin + +[jvm]\ +val [vin](vin.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-odometer/-length/-k-i-l-o-m-e-t-e-r-s/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-odometer/-length/-k-i-l-o-m-e-t-e-r-s/index.md new file mode 100644 index 0000000..3b520a3 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-odometer/-length/-k-i-l-o-m-e-t-e-r-s/index.md @@ -0,0 +1,15 @@ +//[hmkit-fleet](../../../../../index.md)/[com.highmobility.hmkitfleet.model](../../../index.md)/[Odometer](../../index.md)/[Length](../index.md)/[KILOMETERS](index.md) + +# KILOMETERS + +[jvm]\ +@SerialName(value = "kilometers") + +[KILOMETERS](index.md) + +## Properties + +| Name | Summary | +|---|---| +| [name](../../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-odometer/-length/-m-i-l-e-s/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-odometer/-length/-m-i-l-e-s/index.md new file mode 100644 index 0000000..90df5b6 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-odometer/-length/-m-i-l-e-s/index.md @@ -0,0 +1,15 @@ +//[hmkit-fleet](../../../../../index.md)/[com.highmobility.hmkitfleet.model](../../../index.md)/[Odometer](../../index.md)/[Length](../index.md)/[MILES](index.md) + +# MILES + +[jvm]\ +@SerialName(value = "miles") + +[MILES](index.md) + +## Properties + +| Name | Summary | +|---|---| +| [name](../../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-odometer/-length/entries.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-odometer/-length/entries.md new file mode 100644 index 0000000..8d58bcb --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-odometer/-length/entries.md @@ -0,0 +1,10 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet.model](../../index.md)/[Odometer](../index.md)/[Length](index.md)/[entries](entries.md) + +# entries + +[jvm]\ +val [entries](entries.md): [EnumEntries](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.enums/-enum-entries/index.html)<[Odometer.Length](index.md)> + +Returns a representation of an immutable list of all enum entries, in the order they're declared. + +This method may be used to iterate over the enum entries. diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-odometer/-length/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-odometer/-length/index.md new file mode 100644 index 0000000..497f2ff --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-odometer/-length/index.md @@ -0,0 +1,30 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet.model](../../index.md)/[Odometer](../index.md)/[Length](index.md) + +# Length + +[jvm]\ +@Serializable + +enum [Length](index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[Odometer.Length](index.md)> + +## Entries + +| | | +|---|---| +| [KILOMETERS](-k-i-l-o-m-e-t-e-r-s/index.md) | [jvm]
@SerialName(value = "kilometers")
[KILOMETERS](-k-i-l-o-m-e-t-e-r-s/index.md) | +| [MILES](-m-i-l-e-s/index.md) | [jvm]
@SerialName(value = "miles")
[MILES](-m-i-l-e-s/index.md) | + +## Properties + +| Name | Summary | +|---|---| +| [entries](entries.md) | [jvm]
val [entries](entries.md): [EnumEntries](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.enums/-enum-entries/index.html)<[Odometer.Length](index.md)>
Returns a representation of an immutable list of all enum entries, in the order they're declared. | +| [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../../-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | + +## Functions + +| Name | Summary | +|---|---| +| [valueOf](value-of.md) | [jvm]
fun [valueOf](value-of.md)(value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [Odometer.Length](index.md)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) | +| [values](values.md) | [jvm]
fun [values](values.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Odometer.Length](index.md)>
Returns an array containing the constants of this enum type, in the order they're declared. | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-odometer/-length/value-of.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-odometer/-length/value-of.md new file mode 100644 index 0000000..770b1ec --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-odometer/-length/value-of.md @@ -0,0 +1,14 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet.model](../../index.md)/[Odometer](../index.md)/[Length](index.md)/[valueOf](value-of.md) + +# valueOf + +[jvm]\ +fun [valueOf](value-of.md)(value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [Odometer.Length](index.md) + +Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) + +#### Throws + +| | | +|---|---| +| [IllegalArgumentException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html) | if this enum type has no constant with the specified name | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-odometer/-length/values.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-odometer/-length/values.md new file mode 100644 index 0000000..d3b04be --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-odometer/-length/values.md @@ -0,0 +1,10 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet.model](../../index.md)/[Odometer](../index.md)/[Length](index.md)/[values](values.md) + +# values + +[jvm]\ +fun [values](values.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Odometer.Length](index.md)> + +Returns an array containing the constants of this enum type, in the order they're declared. + +This method may be used to iterate over the constants. diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-odometer/-odometer.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-odometer/-odometer.md new file mode 100644 index 0000000..bbd152b --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-odometer/-odometer.md @@ -0,0 +1,6 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet.model](../index.md)/[Odometer](index.md)/[Odometer](-odometer.md) + +# Odometer + +[jvm]\ +constructor(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), unit: [Odometer.Length](-length/index.md)) diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-odometer/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-odometer/index.md new file mode 100644 index 0000000..1c3c7a9 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-odometer/index.md @@ -0,0 +1,29 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet.model](../index.md)/[Odometer](index.md) + +# Odometer + +[jvm]\ +@Serializable + +@SerialName(value = "odometer") + +data class [Odometer](index.md)(val value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), val unit: [Odometer.Length](-length/index.md)) : [ControlMeasure](../-control-measure/index.md) + +## Constructors + +| | | +|---|---| +| [Odometer](-odometer.md) | [jvm]
constructor(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), unit: [Odometer.Length](-length/index.md)) | + +## Types + +| Name | Summary | +|---|---| +| [Length](-length/index.md) | [jvm]
@Serializable
enum [Length](-length/index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[Odometer.Length](-length/index.md)> | + +## Properties + +| Name | Summary | +|---|---| +| [unit](unit.md) | [jvm]
val [unit](unit.md): [Odometer.Length](-length/index.md) | +| [value](value.md) | [jvm]
val [value](value.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-odometer/unit.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-odometer/unit.md new file mode 100644 index 0000000..ab1aa7a --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-odometer/unit.md @@ -0,0 +1,6 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet.model](../index.md)/[Odometer](index.md)/[unit](unit.md) + +# unit + +[jvm]\ +val [unit](unit.md): [Odometer.Length](-length/index.md) diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-odometer/value.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-odometer/value.md new file mode 100644 index 0000000..ea647c3 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-odometer/value.md @@ -0,0 +1,6 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet.model](../index.md)/[Odometer](index.md)/[value](value.md) + +# value + +[jvm]\ +val [value](value.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-request-clearance-response/-request-clearance-response.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-request-clearance-response/-request-clearance-response.md new file mode 100644 index 0000000..620aa4b --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-request-clearance-response/-request-clearance-response.md @@ -0,0 +1,6 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet.model](../index.md)/[RequestClearanceResponse](index.md)/[RequestClearanceResponse](-request-clearance-response.md) + +# RequestClearanceResponse + +[jvm]\ +constructor(vin: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), status: [ClearanceStatus.Status](../-clearance-status/-status/index.md), description: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null) diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-request-clearance-response/description.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-request-clearance-response/description.md new file mode 100644 index 0000000..2a5812b --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-request-clearance-response/description.md @@ -0,0 +1,8 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet.model](../index.md)/[RequestClearanceResponse](index.md)/[description](description.md) + +# description + +[jvm]\ +val [description](description.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null + +Filled when status is ERROR diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-request-clearance-response/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-request-clearance-response/index.md new file mode 100644 index 0000000..d239402 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-request-clearance-response/index.md @@ -0,0 +1,22 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet.model](../index.md)/[RequestClearanceResponse](index.md) + +# RequestClearanceResponse + +[jvm]\ +@Serializable + +data class [RequestClearanceResponse](index.md)(val vin: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), val status: [ClearanceStatus.Status](../-clearance-status/-status/index.md), val description: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null) + +## Constructors + +| | | +|---|---| +| [RequestClearanceResponse](-request-clearance-response.md) | [jvm]
constructor(vin: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), status: [ClearanceStatus.Status](../-clearance-status/-status/index.md), description: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null) | + +## Properties + +| Name | Summary | +|---|---| +| [description](description.md) | [jvm]
val [description](description.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null
Filled when status is ERROR | +| [status](status.md) | [jvm]
val [status](status.md): [ClearanceStatus.Status](../-clearance-status/-status/index.md) | +| [vin](vin.md) | [jvm]
val [vin](vin.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-request-clearance-response/status.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-request-clearance-response/status.md new file mode 100644 index 0000000..544e244 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-request-clearance-response/status.md @@ -0,0 +1,6 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet.model](../index.md)/[RequestClearanceResponse](index.md)/[status](status.md) + +# status + +[jvm]\ +val [status](status.md): [ClearanceStatus.Status](../-clearance-status/-status/index.md) diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-request-clearance-response/vin.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-request-clearance-response/vin.md new file mode 100644 index 0000000..f4f9e64 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/-request-clearance-response/vin.md @@ -0,0 +1,6 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet.model](../index.md)/[RequestClearanceResponse](index.md)/[vin](vin.md) + +# vin + +[jvm]\ +val [vin](vin.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/index.md new file mode 100644 index 0000000..5dcf4bb --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.model/index.md @@ -0,0 +1,15 @@ +//[hmkit-fleet](../../index.md)/[com.highmobility.hmkitfleet.model](index.md) + +# Package-level declarations + +## Types + +| Name | Summary | +|---|---| +| [Brand](-brand/index.md) | [jvm]
@Serializable
enum [Brand](-brand/index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[Brand](-brand/index.md)> | +| [ChangeLogItem](-change-log-item/index.md) | [jvm]
@Serializable
data class [ChangeLogItem](-change-log-item/index.md)(val status: [ClearanceStatus.Status](-clearance-status/-status/index.md), val timestamp: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) | +| [ClearanceStatus](-clearance-status/index.md) | [jvm]
@Serializable
data class [ClearanceStatus](-clearance-status/index.md)(val vin: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), val status: [ClearanceStatus.Status](-clearance-status/-status/index.md), val brand: [Brand](-brand/index.md)? = null, val changelog: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[ChangeLogItem](-change-log-item/index.md)> = emptyList()) | +| [ControlMeasure](-control-measure/index.md) | [jvm]
@Serializable
sealed class [ControlMeasure](-control-measure/index.md) | +| [EligibilityStatus](-eligibility-status/index.md) | [jvm]
@Serializable
data class [EligibilityStatus](-eligibility-status/index.md)(val vin: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), val eligible: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), val dataDelivery: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[EligibilityStatus.DataDelivery](-eligibility-status/-data-delivery/index.md)> = emptyList(), val connectivityStatus: [EligibilityStatus.ConnectivityStatus](-eligibility-status/-connectivity-status/index.md)? = null, val primaryUserAssigned: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)? = null) | +| [Odometer](-odometer/index.md) | [jvm]
@Serializable
@SerialName(value = "odometer")
data class [Odometer](-odometer/index.md)(val value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), val unit: [Odometer.Length](-odometer/-length/index.md)) : [ControlMeasure](-control-measure/index.md) | +| [RequestClearanceResponse](-request-clearance-response/index.md) | [jvm]
@Serializable
data class [RequestClearanceResponse](-request-clearance-response/index.md)(val vin: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), val status: [ClearanceStatus.Status](-clearance-status/-status/index.md), val description: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.network/-error/-error.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.network/-error/-error.md new file mode 100644 index 0000000..8068ccf --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.network/-error/-error.md @@ -0,0 +1,6 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet.network](../index.md)/[Error](index.md)/[Error](-error.md) + +# Error + +[jvm]\ +constructor(title: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), detail: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, source: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null) diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.network/-error/detail.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.network/-error/detail.md new file mode 100644 index 0000000..dc7f999 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.network/-error/detail.md @@ -0,0 +1,6 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet.network](../index.md)/[Error](index.md)/[detail](detail.md) + +# detail + +[jvm]\ +val [detail](detail.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.network/-error/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.network/-error/index.md new file mode 100644 index 0000000..1c9831e --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.network/-error/index.md @@ -0,0 +1,22 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet.network](../index.md)/[Error](index.md) + +# Error + +[jvm]\ +@Serializable + +data class [Error](index.md)(val title: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), val detail: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, val source: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null) + +## Constructors + +| | | +|---|---| +| [Error](-error.md) | [jvm]
constructor(title: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), detail: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, source: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null) | + +## Properties + +| Name | Summary | +|---|---| +| [detail](detail.md) | [jvm]
val [detail](detail.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null | +| [source](source.md) | [jvm]
val [source](source.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null | +| [title](title.md) | [jvm]
val [title](title.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.network/-error/source.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.network/-error/source.md new file mode 100644 index 0000000..e505828 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.network/-error/source.md @@ -0,0 +1,6 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet.network](../index.md)/[Error](index.md)/[source](source.md) + +# source + +[jvm]\ +val [source](source.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.network/-error/title.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.network/-error/title.md new file mode 100644 index 0000000..bee4a47 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.network/-error/title.md @@ -0,0 +1,6 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet.network](../index.md)/[Error](index.md)/[title](title.md) + +# title + +[jvm]\ +val [title](title.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.network/-response/-response.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.network/-response/-response.md new file mode 100644 index 0000000..5b1b486 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.network/-response/-response.md @@ -0,0 +1,6 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet.network](../index.md)/[Response](index.md)/[Response](-response.md) + +# Response + +[jvm]\ +constructor(response: [T](index.md)? = null, error: [Error](../-error/index.md)? = null) diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.network/-response/error.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.network/-response/error.md new file mode 100644 index 0000000..a1e663c --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.network/-response/error.md @@ -0,0 +1,6 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet.network](../index.md)/[Response](index.md)/[error](error.md) + +# error + +[jvm]\ +val [error](error.md): [Error](../-error/index.md)? = null diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.network/-response/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.network/-response/index.md new file mode 100644 index 0000000..7dd0792 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.network/-response/index.md @@ -0,0 +1,19 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet.network](../index.md)/[Response](index.md) + +# Response + +[jvm]\ +data class [Response](index.md)<[T](index.md)>(val response: [T](index.md)? = null, val error: [Error](../-error/index.md)? = null) + +## Constructors + +| | | +|---|---| +| [Response](-response.md) | [jvm]
constructor(response: [T](index.md)? = null, error: [Error](../-error/index.md)? = null) | + +## Properties + +| Name | Summary | +|---|---| +| [error](error.md) | [jvm]
val [error](error.md): [Error](../-error/index.md)? = null | +| [response](response.md) | [jvm]
val [response](response.md): [T](index.md)? = null | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.network/-response/response.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.network/-response/response.md new file mode 100644 index 0000000..3876baa --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.network/-response/response.md @@ -0,0 +1,6 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet.network](../index.md)/[Response](index.md)/[response](response.md) + +# response + +[jvm]\ +val [response](response.md): [T](index.md)? = null diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet.network/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet.network/index.md new file mode 100644 index 0000000..70c1b72 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet.network/index.md @@ -0,0 +1,10 @@ +//[hmkit-fleet](../../index.md)/[com.highmobility.hmkitfleet.network](index.md) + +# Package-level declarations + +## Types + +| Name | Summary | +|---|---| +| [Error](-error/index.md) | [jvm]
@Serializable
data class [Error](-error/index.md)(val title: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), val detail: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, val source: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null) | +| [Response](-response/index.md) | [jvm]
data class [Response](-response/index.md)<[T](-response/index.md)>(val response: [T](-response/index.md)? = null, val error: [Error](-error/index.md)? = null) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/-builder/-builder.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/-builder/-builder.md new file mode 100644 index 0000000..83ca7b2 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/-builder/-builder.md @@ -0,0 +1,6 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet](../../index.md)/[HMKitConfiguration](../index.md)/[Builder](index.md)/[Builder](-builder.md) + +# Builder + +[jvm]\ +constructor() diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/-builder/build.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/-builder/build.md new file mode 100644 index 0000000..683e63b --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/-builder/build.md @@ -0,0 +1,6 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet](../../index.md)/[HMKitConfiguration](../index.md)/[Builder](index.md)/[build](build.md) + +# build + +[jvm]\ +fun [build](build.md)(): [HMKitConfiguration](../index.md) diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/-builder/client.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/-builder/client.md new file mode 100644 index 0000000..44da1e6 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/-builder/client.md @@ -0,0 +1,11 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet](../../index.md)/[HMKitConfiguration](../index.md)/[Builder](index.md)/[client](client.md) + +# client + +[jvm]\ +fun [client](client.md)(client: OkHttpClient): [HMKitConfiguration.Builder](index.md) + +Optionally, set the OkHttpClient to be used for network requests. + +[jvm]\ +var [client](client.md): OkHttpClient? diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/-builder/credentials.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/-builder/credentials.md new file mode 100644 index 0000000..cd6a0df --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/-builder/credentials.md @@ -0,0 +1,11 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet](../../index.md)/[HMKitConfiguration](../index.md)/[Builder](index.md)/[credentials](credentials.md) + +# credentials + +[jvm]\ +fun [credentials](credentials.md)(credentials: [HMKitCredentials](../../-h-m-kit-credentials/index.md)): [HMKitConfiguration.Builder](index.md) + +Set the credentials to be used for the SDK. Choose from either [HMKitOAuthCredentials](../../-h-m-kit-o-auth-credentials/index.md) or [HMKitPrivateKeyCredentials](../../-h-m-kit-private-key-credentials/index.md). This is a mandatory field. + +[jvm]\ +var [credentials](credentials.md): [HMKitCredentials](../../-h-m-kit-credentials/index.md)? diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/-builder/environment.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/-builder/environment.md new file mode 100644 index 0000000..8ef38f3 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/-builder/environment.md @@ -0,0 +1,11 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet](../../index.md)/[HMKitConfiguration](../index.md)/[Builder](index.md)/[environment](environment.md) + +# environment + +[jvm]\ +fun [environment](environment.md)(environment: [HMKitFleet.Environment](../../-h-m-kit-fleet/-environment/index.md)): [HMKitConfiguration.Builder](index.md) + +Set the SDK environment. Default is Production. + +[jvm]\ +var [environment](environment.md): [HMKitFleet.Environment](../../-h-m-kit-fleet/-environment/index.md) diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/-builder/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/-builder/index.md new file mode 100644 index 0000000..1e75b33 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/-builder/index.md @@ -0,0 +1,29 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet](../../index.md)/[HMKitConfiguration](../index.md)/[Builder](index.md) + +# Builder + +[jvm]\ +class [Builder](index.md) + +## Constructors + +| | | +|---|---| +| [Builder](-builder.md) | [jvm]
constructor() | + +## Properties + +| Name | Summary | +|---|---| +| [client](client.md) | [jvm]
var [client](client.md): OkHttpClient? | +| [credentials](credentials.md) | [jvm]
var [credentials](credentials.md): [HMKitCredentials](../../-h-m-kit-credentials/index.md)? | +| [environment](environment.md) | [jvm]
var [environment](environment.md): [HMKitFleet.Environment](../../-h-m-kit-fleet/-environment/index.md) | + +## Functions + +| Name | Summary | +|---|---| +| [build](build.md) | [jvm]
fun [build](build.md)(): [HMKitConfiguration](../index.md) | +| [client](client.md) | [jvm]
fun [client](client.md)(client: OkHttpClient): [HMKitConfiguration.Builder](index.md)
Optionally, set the OkHttpClient to be used for network requests. | +| [credentials](credentials.md) | [jvm]
fun [credentials](credentials.md)(credentials: [HMKitCredentials](../../-h-m-kit-credentials/index.md)): [HMKitConfiguration.Builder](index.md)
Set the credentials to be used for the SDK. Choose from either [HMKitOAuthCredentials](../../-h-m-kit-o-auth-credentials/index.md) or [HMKitPrivateKeyCredentials](../../-h-m-kit-private-key-credentials/index.md). This is a mandatory field. | +| [environment](environment.md) | [jvm]
fun [environment](environment.md)(environment: [HMKitFleet.Environment](../../-h-m-kit-fleet/-environment/index.md)): [HMKitConfiguration.Builder](index.md)
Set the SDK environment. Default is Production. | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/client.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/client.md new file mode 100644 index 0000000..737a03e --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/client.md @@ -0,0 +1,6 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet](../index.md)/[HMKitConfiguration](index.md)/[client](client.md) + +# client + +[jvm]\ +val [client](client.md): OkHttpClient diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/credentials.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/credentials.md new file mode 100644 index 0000000..0d91e76 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/credentials.md @@ -0,0 +1,6 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet](../index.md)/[HMKitConfiguration](index.md)/[credentials](credentials.md) + +# credentials + +[jvm]\ +val [credentials](credentials.md): [HMKitCredentials](../-h-m-kit-credentials/index.md) diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/environment.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/environment.md new file mode 100644 index 0000000..5353ceb --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/environment.md @@ -0,0 +1,6 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet](../index.md)/[HMKitConfiguration](index.md)/[environment](environment.md) + +# environment + +[jvm]\ +val [environment](environment.md): [HMKitFleet.Environment](../-h-m-kit-fleet/-environment/index.md) diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/index.md new file mode 100644 index 0000000..3e131b9 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/index.md @@ -0,0 +1,31 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet](../index.md)/[HMKitConfiguration](index.md) + +# HMKitConfiguration + +class [HMKitConfiguration](index.md) + +The configuration for the SDK. This is a mandatory class to be passed to the SDK. + +#### Parameters + +jvm + +| | | +|---|---| +| credentials | The credentials to be used for the SDK. Choose from either [HMKitOAuthCredentials](../-h-m-kit-o-auth-credentials/index.md) or [HMKitPrivateKeyCredentials](../-h-m-kit-private-key-credentials/index.md). | +| environment | The SDK environment. Default is Production. | +| client | Optionally, set the OkHttpClient to be used for network requests.
[Check out the Javadoc](https://highmobility.github.io/hmkit-fleet/v2/javadoc/com/highmobility/hmkitfleet/HMKitConfiguration.html) | + +## Types + +| Name | Summary | +|---|---| +| [Builder](-builder/index.md) | [jvm]
class [Builder](-builder/index.md) | + +## Properties + +| Name | Summary | +|---|---| +| [client](client.md) | [jvm]
val [client](client.md): OkHttpClient | +| [credentials](credentials.md) | [jvm]
val [credentials](credentials.md): [HMKitCredentials](../-h-m-kit-credentials/index.md) | +| [environment](environment.md) | [jvm]
val [environment](environment.md): [HMKitFleet.Environment](../-h-m-kit-fleet/-environment/index.md) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-credentials/-h-m-kit-credentials.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-credentials/-h-m-kit-credentials.md new file mode 100644 index 0000000..f542dbc --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-credentials/-h-m-kit-credentials.md @@ -0,0 +1,6 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet](../index.md)/[HMKitCredentials](index.md)/[HMKitCredentials](-h-m-kit-credentials.md) + +# HMKitCredentials + +[jvm]\ +constructor() diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-credentials/-jwt-provider/generate-uuid.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-credentials/-jwt-provider/generate-uuid.md new file mode 100644 index 0000000..828386e --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-credentials/-jwt-provider/generate-uuid.md @@ -0,0 +1,6 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet](../../index.md)/[HMKitCredentials](../index.md)/[JwtProvider](index.md)/[generateUuid](generate-uuid.md) + +# generateUuid + +[jvm]\ +abstract fun [generateUuid](generate-uuid.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-credentials/-jwt-provider/get-base-url.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-credentials/-jwt-provider/get-base-url.md new file mode 100644 index 0000000..222107c --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-credentials/-jwt-provider/get-base-url.md @@ -0,0 +1,6 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet](../../index.md)/[HMKitCredentials](../index.md)/[JwtProvider](index.md)/[getBaseUrl](get-base-url.md) + +# getBaseUrl + +[jvm]\ +abstract fun [getBaseUrl](get-base-url.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-credentials/-jwt-provider/get-timestamp.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-credentials/-jwt-provider/get-timestamp.md new file mode 100644 index 0000000..bd04ba0 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-credentials/-jwt-provider/get-timestamp.md @@ -0,0 +1,6 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet](../../index.md)/[HMKitCredentials](../index.md)/[JwtProvider](index.md)/[getTimestamp](get-timestamp.md) + +# getTimestamp + +[jvm]\ +abstract fun [getTimestamp](get-timestamp.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-credentials/-jwt-provider/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-credentials/-jwt-provider/index.md new file mode 100644 index 0000000..dd00335 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-credentials/-jwt-provider/index.md @@ -0,0 +1,14 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet](../../index.md)/[HMKitCredentials](../index.md)/[JwtProvider](index.md) + +# JwtProvider + +[jvm]\ +interface [JwtProvider](index.md) + +## Functions + +| Name | Summary | +|---|---| +| [generateUuid](generate-uuid.md) | [jvm]
abstract fun [generateUuid](generate-uuid.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [getBaseUrl](get-base-url.md) | [jvm]
abstract fun [getBaseUrl](get-base-url.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [getTimestamp](get-timestamp.md) | [jvm]
abstract fun [getTimestamp](get-timestamp.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-credentials/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-credentials/index.md new file mode 100644 index 0000000..4df351e --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-credentials/index.md @@ -0,0 +1,28 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet](../index.md)/[HMKitCredentials](index.md) + +# HMKitCredentials + +abstract class [HMKitCredentials](index.md) + +The credentials to be used for the SDK. Choose from either [HMKitOAuthCredentials](../-h-m-kit-o-auth-credentials/index.md) or [HMKitPrivateKeyCredentials](../-h-m-kit-private-key-credentials/index.md). + +[Check out the Javadoc](https://highmobility.github.io/hmkit-fleet/v2/javadoc/com/highmobility/hmkitfleet/HMKitCredentials.html) + +#### Inheritors + +| | +|---| +| [HMKitOAuthCredentials](../-h-m-kit-o-auth-credentials/index.md) | +| [HMKitPrivateKeyCredentials](../-h-m-kit-private-key-credentials/index.md) | + +## Constructors + +| | | +|---|---| +| [HMKitCredentials](-h-m-kit-credentials.md) | [jvm]
constructor() | + +## Types + +| Name | Summary | +|---|---| +| [JwtProvider](-jwt-provider/index.md) | [jvm]
interface [JwtProvider](-jwt-provider/index.md) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/-environment/-companion/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/-environment/-companion/index.md new file mode 100644 index 0000000..4b47240 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/-environment/-companion/index.md @@ -0,0 +1,12 @@ +//[hmkit-fleet](../../../../../index.md)/[com.highmobility.hmkitfleet](../../../index.md)/[HMKitFleet](../../index.md)/[Environment](../index.md)/[Companion](index.md) + +# Companion + +[jvm]\ +object [Companion](index.md) + +## Properties + +| Name | Summary | +|---|---| +| [webUrl](web-url.md) | [jvm]
@[JvmField](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-field/index.html)
var [webUrl](web-url.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?
Override the web url, which is normally derived from the HMKitFleet.environment value. | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/-environment/-companion/web-url.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/-environment/-companion/web-url.md new file mode 100644 index 0000000..2a7b00c --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/-environment/-companion/web-url.md @@ -0,0 +1,11 @@ +//[hmkit-fleet](../../../../../index.md)/[com.highmobility.hmkitfleet](../../../index.md)/[HMKitFleet](../../index.md)/[Environment](../index.md)/[Companion](index.md)/[webUrl](web-url.md) + +# webUrl + +[jvm]\ + +@[JvmField](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-field/index.html) + +var [webUrl](web-url.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? + +Override the web url, which is normally derived from the HMKitFleet.environment value. diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/-environment/-p-r-o-d-u-c-t-i-o-n/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/-environment/-p-r-o-d-u-c-t-i-o-n/index.md new file mode 100644 index 0000000..a2571b4 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/-environment/-p-r-o-d-u-c-t-i-o-n/index.md @@ -0,0 +1,13 @@ +//[hmkit-fleet](../../../../../index.md)/[com.highmobility.hmkitfleet](../../../index.md)/[HMKitFleet](../../index.md)/[Environment](../index.md)/[PRODUCTION](index.md) + +# PRODUCTION + +[jvm]\ +[PRODUCTION](index.md) + +## Properties + +| Name | Summary | +|---|---| +| [name](../../../../com.highmobility.hmkitfleet.model/-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../../../../com.highmobility.hmkitfleet.model/-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../../../com.highmobility.hmkitfleet.model/-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../../../../com.highmobility.hmkitfleet.model/-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/-environment/-s-a-n-d-b-o-x/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/-environment/-s-a-n-d-b-o-x/index.md new file mode 100644 index 0000000..73f3c99 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/-environment/-s-a-n-d-b-o-x/index.md @@ -0,0 +1,13 @@ +//[hmkit-fleet](../../../../../index.md)/[com.highmobility.hmkitfleet](../../../index.md)/[HMKitFleet](../../index.md)/[Environment](../index.md)/[SANDBOX](index.md) + +# SANDBOX + +[jvm]\ +[SANDBOX](index.md) + +## Properties + +| Name | Summary | +|---|---| +| [name](../../../../com.highmobility.hmkitfleet.model/-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../../../../com.highmobility.hmkitfleet.model/-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../../../com.highmobility.hmkitfleet.model/-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../../../../com.highmobility.hmkitfleet.model/-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/-environment/entries.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/-environment/entries.md new file mode 100644 index 0000000..12bd5cc --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/-environment/entries.md @@ -0,0 +1,10 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet](../../index.md)/[HMKitFleet](../index.md)/[Environment](index.md)/[entries](entries.md) + +# entries + +[jvm]\ +val [entries](entries.md): [EnumEntries](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.enums/-enum-entries/index.html)<[HMKitFleet.Environment](index.md)> + +Returns a representation of an immutable list of all enum entries, in the order they're declared. + +This method may be used to iterate over the enum entries. diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/-environment/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/-environment/index.md new file mode 100644 index 0000000..ec5be98 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/-environment/index.md @@ -0,0 +1,38 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet](../../index.md)/[HMKitFleet](../index.md)/[Environment](index.md) + +# Environment + +[jvm]\ +enum [Environment](index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[HMKitFleet.Environment](index.md)> + +The Fleet SDK environment. + +[Check out the Javadoc](https://highmobility.github.io/hmkit-fleet/v2/javadoc/com/highmobility/hmkitfleet/HMKitFleet.Environment.html) + +## Entries + +| | | +|---|---| +| [PRODUCTION](-p-r-o-d-u-c-t-i-o-n/index.md) | [jvm]
[PRODUCTION](-p-r-o-d-u-c-t-i-o-n/index.md) | +| [SANDBOX](-s-a-n-d-b-o-x/index.md) | [jvm]
[SANDBOX](-s-a-n-d-b-o-x/index.md) | + +## Types + +| Name | Summary | +|---|---| +| [Companion](-companion/index.md) | [jvm]
object [Companion](-companion/index.md) | + +## Properties + +| Name | Summary | +|---|---| +| [entries](entries.md) | [jvm]
val [entries](entries.md): [EnumEntries](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.enums/-enum-entries/index.html)<[HMKitFleet.Environment](index.md)>
Returns a representation of an immutable list of all enum entries, in the order they're declared. | +| [name](../../../com.highmobility.hmkitfleet.model/-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432) | [jvm]
val [name](../../../com.highmobility.hmkitfleet.model/-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-372974862%2FProperties%2F-1829386432): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../../com.highmobility.hmkitfleet.model/-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432) | [jvm]
val [ordinal](../../../com.highmobility.hmkitfleet.model/-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md#-739389684%2FProperties%2F-1829386432): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | + +## Functions + +| Name | Summary | +|---|---| +| [valueOf](value-of.md) | [jvm]
fun [valueOf](value-of.md)(value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [HMKitFleet.Environment](index.md)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) | +| [values](values.md) | [jvm]
fun [values](values.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[HMKitFleet.Environment](index.md)>
Returns an array containing the constants of this enum type, in the order they're declared. | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/-environment/value-of.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/-environment/value-of.md new file mode 100644 index 0000000..5a9d43b --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/-environment/value-of.md @@ -0,0 +1,14 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet](../../index.md)/[HMKitFleet](../index.md)/[Environment](index.md)/[valueOf](value-of.md) + +# valueOf + +[jvm]\ +fun [valueOf](value-of.md)(value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [HMKitFleet.Environment](index.md) + +Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) + +#### Throws + +| | | +|---|---| +| [IllegalArgumentException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html) | if this enum type has no constant with the specified name | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/-environment/values.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/-environment/values.md new file mode 100644 index 0000000..e9559cf --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/-environment/values.md @@ -0,0 +1,10 @@ +//[hmkit-fleet](../../../../index.md)/[com.highmobility.hmkitfleet](../../index.md)/[HMKitFleet](../index.md)/[Environment](index.md)/[values](values.md) + +# values + +[jvm]\ +fun [values](values.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[HMKitFleet.Environment](index.md)> + +Returns an array containing the constants of this enum type, in the order they're declared. + +This method may be used to iterate over the constants. diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/-h-m-kit-fleet.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/-h-m-kit-fleet.md new file mode 100644 index 0000000..b463ad4 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/-h-m-kit-fleet.md @@ -0,0 +1,6 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet](../index.md)/[HMKitFleet](index.md)/[HMKitFleet](-h-m-kit-fleet.md) + +# HMKitFleet + +[jvm]\ +constructor(hmKitConfiguration: [HMKitConfiguration](../-h-m-kit-configuration/index.md)) diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/delete-clearance.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/delete-clearance.md new file mode 100644 index 0000000..93adbf0 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/delete-clearance.md @@ -0,0 +1,22 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet](../index.md)/[HMKitFleet](index.md)/[deleteClearance](delete-clearance.md) + +# deleteClearance + +[jvm]\ +fun [deleteClearance](delete-clearance.md)(vin: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [CompletableFuture](https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html)<[Response](../../com.highmobility.hmkitfleet.network/-response/index.md)<[RequestClearanceResponse](../../com.highmobility.hmkitfleet.model/-request-clearance-response/index.md)>> + +Delete the clearance for the given VIN. + +If the clearance is in a pending state, the activation process is canceled. If the vehicle is in an approved state, a revoke is attempted. If the revoke is successful, the VehicleAccess object for this VIN becomes invalid. + +#### Return + +The clearance status + +#### Parameters + +jvm + +| | | +|---|---| +| vin | The vehicle VIN number | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/get-clearance-status.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/get-clearance-status.md new file mode 100644 index 0000000..a04141d --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/get-clearance-status.md @@ -0,0 +1,12 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet](../index.md)/[HMKitFleet](index.md)/[getClearanceStatus](get-clearance-status.md) + +# getClearanceStatus + +[jvm]\ +fun [getClearanceStatus](get-clearance-status.md)(vin: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [CompletableFuture](https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html)<[Response](../../com.highmobility.hmkitfleet.network/-response/index.md)<[ClearanceStatus](../../com.highmobility.hmkitfleet.model/-clearance-status/index.md)>> + +Get the status of a [vin](get-clearance-status.md) that has previously been registered for data access clearance with [requestClearance](request-clearance.md). After the [vin](get-clearance-status.md) is Approved, getVehicleAccess and subsequent sendCommand can be sent. + +#### Return + +The clearance status diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/get-clearance-statuses.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/get-clearance-statuses.md new file mode 100644 index 0000000..6128e74 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/get-clearance-statuses.md @@ -0,0 +1,12 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet](../index.md)/[HMKitFleet](index.md)/[getClearanceStatuses](get-clearance-statuses.md) + +# getClearanceStatuses + +[jvm]\ +fun [getClearanceStatuses](get-clearance-statuses.md)(): [CompletableFuture](https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html)<[Response](../../com.highmobility.hmkitfleet.network/-response/index.md)<[List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[ClearanceStatus](../../com.highmobility.hmkitfleet.model/-clearance-status/index.md)>>> + +Get the status of VINs that have previously been registered for data access clearance with [requestClearance](request-clearance.md). After VIN is Approved, getVehicleAccess and subsequent sendCommand can be sent. + +#### Return + +The clearance statuses diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/get-eligibility.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/get-eligibility.md new file mode 100644 index 0000000..317f6b0 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/get-eligibility.md @@ -0,0 +1,21 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet](../index.md)/[HMKitFleet](index.md)/[getEligibility](get-eligibility.md) + +# getEligibility + +[jvm]\ +fun [getEligibility](get-eligibility.md)(vin: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), brand: [Brand](../../com.highmobility.hmkitfleet.model/-brand/index.md)): [CompletableFuture](https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html)<[Response](../../com.highmobility.hmkitfleet.network/-response/index.md)<[EligibilityStatus](../../com.highmobility.hmkitfleet.model/-eligibility-status/index.md)>> + +Get the eligibility status for a specific VIN. This can be used to find out if the vehicle has the necessary connectivity to transmit data. + +#### Return + +The eligibility status + +#### Parameters + +jvm + +| | | +|---|---| +| vin | The vehicle VIN number | +| brand | The vehicle brand | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/get-vehicle-state.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/get-vehicle-state.md new file mode 100644 index 0000000..2366fa2 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/get-vehicle-state.md @@ -0,0 +1,10 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet](../index.md)/[HMKitFleet](index.md)/[getVehicleState](get-vehicle-state.md) + +# getVehicleState + +[jvm]\ +fun [getVehicleState](get-vehicle-state.md)(vin: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [CompletableFuture](https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html)<[Response](../../com.highmobility.hmkitfleet.network/-response/index.md)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>> + +Get vehicle status JSON string from the [Vehicle Data API](https://docs.high-mobility.com/api-references/code-references/vehicle-data/reference/v1/) + +Read more in the [Vehicle Data API Tutorial](https://docs.high-mobility.com/guides/getting-started/rest/) diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/get-vehicle-static-data.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/get-vehicle-static-data.md new file mode 100644 index 0000000..2330d60 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/get-vehicle-static-data.md @@ -0,0 +1,10 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet](../index.md)/[HMKitFleet](index.md)/[getVehicleStaticData](get-vehicle-static-data.md) + +# getVehicleStaticData + +[jvm]\ +fun [getVehicleStaticData](get-vehicle-static-data.md)(vin: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [CompletableFuture](https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html)<[Response](../../com.highmobility.hmkitfleet.network/-response/index.md)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>> + +Get the static information about a vehicle. Static data can include the vehicle's brand, equipment and more. + +Read more in the [Static Data API Tutorial](https://docs.high-mobility.com/guides/getting-started/static-data-api/) diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/index.md new file mode 100644 index 0000000..fcf2138 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/index.md @@ -0,0 +1,42 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet](../index.md)/[HMKitFleet](index.md) + +# HMKitFleet + +[jvm]\ +class [HMKitFleet](index.md)(hmKitConfiguration: [HMKitConfiguration](../-h-m-kit-configuration/index.md)) + +HMKitFleet is the access point for the Fleet SDK functionality. It is accessed by creating a new HMKitFleet object with a HMKitConfiguration object. + +```kotlin +HMKitFleet fleet = new HMKitFleet( + new HMKitConfiguration.Builder() + .credentials(new HMKitOAuthCredentials("client_id", "client_secret")) + .build() +); +``` + +[Check out the Javadoc](https://highmobility.github.io/hmkit-fleet/v2/javadoc/com/highmobility/hmkitfleet/HMKitFleet.html) + +## Constructors + +| | | +|---|---| +| [HMKitFleet](-h-m-kit-fleet.md) | [jvm]
constructor(hmKitConfiguration: [HMKitConfiguration](../-h-m-kit-configuration/index.md)) | + +## Types + +| Name | Summary | +|---|---| +| [Environment](-environment/index.md) | [jvm]
enum [Environment](-environment/index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[HMKitFleet.Environment](-environment/index.md)>
The Fleet SDK environment. | + +## Functions + +| Name | Summary | +|---|---| +| [deleteClearance](delete-clearance.md) | [jvm]
fun [deleteClearance](delete-clearance.md)(vin: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [CompletableFuture](https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html)<[Response](../../com.highmobility.hmkitfleet.network/-response/index.md)<[RequestClearanceResponse](../../com.highmobility.hmkitfleet.model/-request-clearance-response/index.md)>>
Delete the clearance for the given VIN. | +| [getClearanceStatus](get-clearance-status.md) | [jvm]
fun [getClearanceStatus](get-clearance-status.md)(vin: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [CompletableFuture](https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html)<[Response](../../com.highmobility.hmkitfleet.network/-response/index.md)<[ClearanceStatus](../../com.highmobility.hmkitfleet.model/-clearance-status/index.md)>>
Get the status of a [vin](get-clearance-status.md) that has previously been registered for data access clearance with [requestClearance](request-clearance.md). After the [vin](get-clearance-status.md) is Approved, getVehicleAccess and subsequent sendCommand can be sent. | +| [getClearanceStatuses](get-clearance-statuses.md) | [jvm]
fun [getClearanceStatuses](get-clearance-statuses.md)(): [CompletableFuture](https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html)<[Response](../../com.highmobility.hmkitfleet.network/-response/index.md)<[List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[ClearanceStatus](../../com.highmobility.hmkitfleet.model/-clearance-status/index.md)>>>
Get the status of VINs that have previously been registered for data access clearance with [requestClearance](request-clearance.md). After VIN is Approved, getVehicleAccess and subsequent sendCommand can be sent. | +| [getEligibility](get-eligibility.md) | [jvm]
fun [getEligibility](get-eligibility.md)(vin: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), brand: [Brand](../../com.highmobility.hmkitfleet.model/-brand/index.md)): [CompletableFuture](https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html)<[Response](../../com.highmobility.hmkitfleet.network/-response/index.md)<[EligibilityStatus](../../com.highmobility.hmkitfleet.model/-eligibility-status/index.md)>>
Get the eligibility status for a specific VIN. This can be used to find out if the vehicle has the necessary connectivity to transmit data. | +| [getVehicleState](get-vehicle-state.md) | [jvm]
fun [getVehicleState](get-vehicle-state.md)(vin: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [CompletableFuture](https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html)<[Response](../../com.highmobility.hmkitfleet.network/-response/index.md)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>>
Get vehicle status JSON string from the [Vehicle Data API](https://docs.high-mobility.com/api-references/code-references/vehicle-data/reference/v1/) | +| [getVehicleStaticData](get-vehicle-static-data.md) | [jvm]
fun [getVehicleStaticData](get-vehicle-static-data.md)(vin: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [CompletableFuture](https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html)<[Response](../../com.highmobility.hmkitfleet.network/-response/index.md)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>>
Get the static information about a vehicle. Static data can include the vehicle's brand, equipment and more. | +| [requestClearance](request-clearance.md) | [jvm]
@[JvmOverloads](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html)
fun [requestClearance](request-clearance.md)(vin: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), brand: [Brand](../../com.highmobility.hmkitfleet.model/-brand/index.md), controlMeasures: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[ControlMeasure](../../com.highmobility.hmkitfleet.model/-control-measure/index.md)>? = null): [CompletableFuture](https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html)<[Response](../../com.highmobility.hmkitfleet.network/-response/index.md)<[RequestClearanceResponse](../../com.highmobility.hmkitfleet.model/-request-clearance-response/index.md)>>
Start the data access clearance process for a vehicle. | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/request-clearance.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/request-clearance.md new file mode 100644 index 0000000..c0821cc --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/request-clearance.md @@ -0,0 +1,25 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet](../index.md)/[HMKitFleet](index.md)/[requestClearance](request-clearance.md) + +# requestClearance + +[jvm]\ + +@[JvmOverloads](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html) + +fun [requestClearance](request-clearance.md)(vin: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), brand: [Brand](../../com.highmobility.hmkitfleet.model/-brand/index.md), controlMeasures: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[ControlMeasure](../../com.highmobility.hmkitfleet.model/-control-measure/index.md)>? = null): [CompletableFuture](https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html)<[Response](../../com.highmobility.hmkitfleet.network/-response/index.md)<[RequestClearanceResponse](../../com.highmobility.hmkitfleet.model/-request-clearance-response/index.md)>> + +Start the data access clearance process for a vehicle. + +#### Return + +The clearance status + +#### Parameters + +jvm + +| | | +|---|---| +| vin | The vehicle VIN number | +| brand | The vehicle brand | +| controlMeasures | Optional control measures for some vehicle brands. | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-o-auth-credentials/-h-m-kit-o-auth-credentials.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-o-auth-credentials/-h-m-kit-o-auth-credentials.md new file mode 100644 index 0000000..8cb5751 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-o-auth-credentials/-h-m-kit-o-auth-credentials.md @@ -0,0 +1,6 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet](../index.md)/[HMKitOAuthCredentials](index.md)/[HMKitOAuthCredentials](-h-m-kit-o-auth-credentials.md) + +# HMKitOAuthCredentials + +[jvm]\ +constructor(clientId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), clientSecret: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-o-auth-credentials/client-id.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-o-auth-credentials/client-id.md new file mode 100644 index 0000000..f8dade2 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-o-auth-credentials/client-id.md @@ -0,0 +1,8 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet](../index.md)/[HMKitOAuthCredentials](index.md)/[clientId](client-id.md) + +# clientId + +[jvm]\ +val [clientId](client-id.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +The OAuth client ID. diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-o-auth-credentials/client-secret.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-o-auth-credentials/client-secret.md new file mode 100644 index 0000000..66e7197 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-o-auth-credentials/client-secret.md @@ -0,0 +1,8 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet](../index.md)/[HMKitOAuthCredentials](index.md)/[clientSecret](client-secret.md) + +# clientSecret + +[jvm]\ +val [clientSecret](client-secret.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +The OAuth client secret. diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-o-auth-credentials/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-o-auth-credentials/index.md new file mode 100644 index 0000000..02d8de6 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-o-auth-credentials/index.md @@ -0,0 +1,25 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet](../index.md)/[HMKitOAuthCredentials](index.md) + +# HMKitOAuthCredentials + +[jvm]\ +@Serializable + +data class [HMKitOAuthCredentials](index.md)(val clientId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), val clientSecret: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) : [HMKitCredentials](../-h-m-kit-credentials/index.md) + +The OAuth credentials to be used for the SDK. + +[Check out the Javadoc](https://highmobility.github.io/hmkit-fleet/v2/javadoc/com/highmobility/hmkitfleet/HMKitOAuthCredentials.html) + +## Constructors + +| | | +|---|---| +| [HMKitOAuthCredentials](-h-m-kit-o-auth-credentials.md) | [jvm]
constructor(clientId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), clientSecret: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) | + +## Properties + +| Name | Summary | +|---|---| +| [clientId](client-id.md) | [jvm]
val [clientId](client-id.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
The OAuth client ID. | +| [clientSecret](client-secret.md) | [jvm]
val [clientSecret](client-secret.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
The OAuth client secret. | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-private-key-credentials/-h-m-kit-private-key-credentials.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-private-key-credentials/-h-m-kit-private-key-credentials.md new file mode 100644 index 0000000..644cb44 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-private-key-credentials/-h-m-kit-private-key-credentials.md @@ -0,0 +1,6 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet](../index.md)/[HMKitPrivateKeyCredentials](index.md)/[HMKitPrivateKeyCredentials](-h-m-kit-private-key-credentials.md) + +# HMKitPrivateKeyCredentials + +[jvm]\ +constructor(clientId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), privateKey: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), privateKeyId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-private-key-credentials/client-id.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-private-key-credentials/client-id.md new file mode 100644 index 0000000..e5184be --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-private-key-credentials/client-id.md @@ -0,0 +1,8 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet](../index.md)/[HMKitPrivateKeyCredentials](index.md)/[clientId](client-id.md) + +# clientId + +[jvm]\ +val [clientId](client-id.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +The OAuth client ID. diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-private-key-credentials/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-private-key-credentials/index.md new file mode 100644 index 0000000..ae9a0e1 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-private-key-credentials/index.md @@ -0,0 +1,26 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet](../index.md)/[HMKitPrivateKeyCredentials](index.md) + +# HMKitPrivateKeyCredentials + +[jvm]\ +@Serializable + +data class [HMKitPrivateKeyCredentials](index.md)(val clientId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), val privateKey: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), val privateKeyId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) : [HMKitCredentials](../-h-m-kit-credentials/index.md) + +The private key credentials to be used for the SDK. + +[Check out the Javadoc](https://highmobility.github.io/hmkit-fleet/v2/javadoc/com/highmobility/hmkitfleet/HMKitPrivateKeyCredentials.html) + +## Constructors + +| | | +|---|---| +| [HMKitPrivateKeyCredentials](-h-m-kit-private-key-credentials.md) | [jvm]
constructor(clientId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), privateKey: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), privateKeyId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) | + +## Properties + +| Name | Summary | +|---|---| +| [clientId](client-id.md) | [jvm]
val [clientId](client-id.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
The OAuth client ID. | +| [privateKey](private-key.md) | [jvm]
val [privateKey](private-key.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
The PKCS8 formatted private key. It is included in the .json file downloaded from the developer console after creating a new private key in the App>OAuth section. | +| [privateKeyId](private-key-id.md) | [jvm]
val [privateKeyId](private-key-id.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
The private key ID. It is included in the .json file downloaded from the developer console after creating a new private key in the App>OAuth section. | diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-private-key-credentials/private-key-id.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-private-key-credentials/private-key-id.md new file mode 100644 index 0000000..c05f5a9 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-private-key-credentials/private-key-id.md @@ -0,0 +1,8 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet](../index.md)/[HMKitPrivateKeyCredentials](index.md)/[privateKeyId](private-key-id.md) + +# privateKeyId + +[jvm]\ +val [privateKeyId](private-key-id.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +The private key ID. It is included in the .json file downloaded from the developer console after creating a new private key in the App>OAuth section. diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-private-key-credentials/private-key.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-private-key-credentials/private-key.md new file mode 100644 index 0000000..6b98fa6 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-private-key-credentials/private-key.md @@ -0,0 +1,8 @@ +//[hmkit-fleet](../../../index.md)/[com.highmobility.hmkitfleet](../index.md)/[HMKitPrivateKeyCredentials](index.md)/[privateKey](private-key.md) + +# privateKey + +[jvm]\ +val [privateKey](private-key.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +The PKCS8 formatted private key. It is included in the .json file downloaded from the developer console after creating a new private key in the App>OAuth section. diff --git a/docs/hmkit-fleet/com.highmobility.hmkitfleet/index.md b/docs/hmkit-fleet/com.highmobility.hmkitfleet/index.md new file mode 100644 index 0000000..2bff430 --- /dev/null +++ b/docs/hmkit-fleet/com.highmobility.hmkitfleet/index.md @@ -0,0 +1,13 @@ +//[hmkit-fleet](../../index.md)/[com.highmobility.hmkitfleet](index.md) + +# Package-level declarations + +## Types + +| Name | Summary | +|---|---| +| [HMKitConfiguration](-h-m-kit-configuration/index.md) | [jvm]
class [HMKitConfiguration](-h-m-kit-configuration/index.md)
The configuration for the SDK. This is a mandatory class to be passed to the SDK. | +| [HMKitCredentials](-h-m-kit-credentials/index.md) | [jvm]
abstract class [HMKitCredentials](-h-m-kit-credentials/index.md)
The credentials to be used for the SDK. Choose from either [HMKitOAuthCredentials](-h-m-kit-o-auth-credentials/index.md) or [HMKitPrivateKeyCredentials](-h-m-kit-private-key-credentials/index.md). | +| [HMKitFleet](-h-m-kit-fleet/index.md) | [jvm]
class [HMKitFleet](-h-m-kit-fleet/index.md)(hmKitConfiguration: [HMKitConfiguration](-h-m-kit-configuration/index.md))
HMKitFleet is the access point for the Fleet SDK functionality. It is accessed by creating a new HMKitFleet object with a HMKitConfiguration object. | +| [HMKitOAuthCredentials](-h-m-kit-o-auth-credentials/index.md) | [jvm]
@Serializable
data class [HMKitOAuthCredentials](-h-m-kit-o-auth-credentials/index.md)(val clientId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), val clientSecret: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) : [HMKitCredentials](-h-m-kit-credentials/index.md)
The OAuth credentials to be used for the SDK. | +| [HMKitPrivateKeyCredentials](-h-m-kit-private-key-credentials/index.md) | [jvm]
@Serializable
data class [HMKitPrivateKeyCredentials](-h-m-kit-private-key-credentials/index.md)(val clientId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), val privateKey: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), val privateKeyId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) : [HMKitCredentials](-h-m-kit-credentials/index.md)
The private key credentials to be used for the SDK. | diff --git a/docs/hmkit-fleet/package-list b/docs/hmkit-fleet/package-list new file mode 100644 index 0000000..9ab93e4 --- /dev/null +++ b/docs/hmkit-fleet/package-list @@ -0,0 +1,146 @@ +$dokka.format:gfm-v1 +$dokka.linkExtension:md +$dokka.location:com.highmobility.hmkitfleet.model////PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/index.md +$dokka.location:com.highmobility.hmkitfleet.model/Brand.ALFAROMEO///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-a-l-f-a-r-o-m-e-o/index.md +$dokka.location:com.highmobility.hmkitfleet.model/Brand.BMW///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-b-m-w/index.md +$dokka.location:com.highmobility.hmkitfleet.model/Brand.CITROEN///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-c-i-t-r-o-e-n/index.md +$dokka.location:com.highmobility.hmkitfleet.model/Brand.DS///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-d-s/index.md +$dokka.location:com.highmobility.hmkitfleet.model/Brand.FIAT///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-f-i-a-t/index.md +$dokka.location:com.highmobility.hmkitfleet.model/Brand.FORD///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-f-o-r-d/index.md +$dokka.location:com.highmobility.hmkitfleet.model/Brand.JEEP///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-j-e-e-p/index.md +$dokka.location:com.highmobility.hmkitfleet.model/Brand.KIA///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-k-i-a/index.md +$dokka.location:com.highmobility.hmkitfleet.model/Brand.LEXUS///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-l-e-x-u-s/index.md +$dokka.location:com.highmobility.hmkitfleet.model/Brand.MASERATI///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-m-a-s-e-r-a-t-i/index.md +$dokka.location:com.highmobility.hmkitfleet.model/Brand.MERCEDES_BENZ///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-m-e-r-c-e-d-e-s_-b-e-n-z/index.md +$dokka.location:com.highmobility.hmkitfleet.model/Brand.MINI///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-m-i-n-i/index.md +$dokka.location:com.highmobility.hmkitfleet.model/Brand.OPEL///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-o-p-e-l/index.md +$dokka.location:com.highmobility.hmkitfleet.model/Brand.PEUGEOT///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-p-e-u-g-e-o-t/index.md +$dokka.location:com.highmobility.hmkitfleet.model/Brand.PORSCHE///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-p-o-r-s-c-h-e/index.md +$dokka.location:com.highmobility.hmkitfleet.model/Brand.RENAULT///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-r-e-n-a-u-l-t/index.md +$dokka.location:com.highmobility.hmkitfleet.model/Brand.SANDBOX///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-s-a-n-d-b-o-x/index.md +$dokka.location:com.highmobility.hmkitfleet.model/Brand.TESLA///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-t-e-s-l-a/index.md +$dokka.location:com.highmobility.hmkitfleet.model/Brand.TOYOTA///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-t-o-y-o-t-a/index.md +$dokka.location:com.highmobility.hmkitfleet.model/Brand.VAUXHALL///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-v-a-u-x-h-a-l-l/index.md +$dokka.location:com.highmobility.hmkitfleet.model/Brand.VOLVO_CARS///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/-v-o-l-v-o_-c-a-r-s/index.md +$dokka.location:com.highmobility.hmkitfleet.model/Brand///PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/index.md +$dokka.location:com.highmobility.hmkitfleet.model/Brand/entries/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/entries.md +$dokka.location:com.highmobility.hmkitfleet.model/Brand/valueOf/#kotlin.String/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/value-of.md +$dokka.location:com.highmobility.hmkitfleet.model/Brand/values/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-brand/values.md +$dokka.location:com.highmobility.hmkitfleet.model/ChangeLogItem///PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-change-log-item/index.md +$dokka.location:com.highmobility.hmkitfleet.model/ChangeLogItem/ChangeLogItem/#com.highmobility.hmkitfleet.model.ClearanceStatus.Status#kotlin.String/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-change-log-item/-change-log-item.md +$dokka.location:com.highmobility.hmkitfleet.model/ChangeLogItem/status/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-change-log-item/status.md +$dokka.location:com.highmobility.hmkitfleet.model/ChangeLogItem/timestamp/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-change-log-item/timestamp.md +$dokka.location:com.highmobility.hmkitfleet.model/ClearanceStatus.Status.APPROVED///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/-a-p-p-r-o-v-e-d/index.md +$dokka.location:com.highmobility.hmkitfleet.model/ClearanceStatus.Status.CANCELED///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/-c-a-n-c-e-l-e-d/index.md +$dokka.location:com.highmobility.hmkitfleet.model/ClearanceStatus.Status.CANCELING///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/-c-a-n-c-e-l-i-n-g/index.md +$dokka.location:com.highmobility.hmkitfleet.model/ClearanceStatus.Status.ERROR///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/-e-r-r-o-r/index.md +$dokka.location:com.highmobility.hmkitfleet.model/ClearanceStatus.Status.PENDING///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/-p-e-n-d-i-n-g/index.md +$dokka.location:com.highmobility.hmkitfleet.model/ClearanceStatus.Status.REJECTED///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/-r-e-j-e-c-t-e-d/index.md +$dokka.location:com.highmobility.hmkitfleet.model/ClearanceStatus.Status.REVOKED///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/-r-e-v-o-k-e-d/index.md +$dokka.location:com.highmobility.hmkitfleet.model/ClearanceStatus.Status.REVOKING///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/-r-e-v-o-k-i-n-g/index.md +$dokka.location:com.highmobility.hmkitfleet.model/ClearanceStatus.Status///PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/index.md +$dokka.location:com.highmobility.hmkitfleet.model/ClearanceStatus.Status/entries/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/entries.md +$dokka.location:com.highmobility.hmkitfleet.model/ClearanceStatus.Status/valueOf/#kotlin.String/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/value-of.md +$dokka.location:com.highmobility.hmkitfleet.model/ClearanceStatus.Status/values/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-status/values.md +$dokka.location:com.highmobility.hmkitfleet.model/ClearanceStatus///PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/index.md +$dokka.location:com.highmobility.hmkitfleet.model/ClearanceStatus/ClearanceStatus/#kotlin.String#com.highmobility.hmkitfleet.model.ClearanceStatus.Status#com.highmobility.hmkitfleet.model.Brand?#kotlin.collections.List[com.highmobility.hmkitfleet.model.ChangeLogItem]/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/-clearance-status.md +$dokka.location:com.highmobility.hmkitfleet.model/ClearanceStatus/brand/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/brand.md +$dokka.location:com.highmobility.hmkitfleet.model/ClearanceStatus/changelog/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/changelog.md +$dokka.location:com.highmobility.hmkitfleet.model/ClearanceStatus/status/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/status.md +$dokka.location:com.highmobility.hmkitfleet.model/ClearanceStatus/vin/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-clearance-status/vin.md +$dokka.location:com.highmobility.hmkitfleet.model/ControlMeasure///PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-control-measure/index.md +$dokka.location:com.highmobility.hmkitfleet.model/EligibilityStatus.ConnectivityStatus.ACTIVATED///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-connectivity-status/-a-c-t-i-v-a-t-e-d/index.md +$dokka.location:com.highmobility.hmkitfleet.model/EligibilityStatus.ConnectivityStatus.DEACTIVATED///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-connectivity-status/-d-e-a-c-t-i-v-a-t-e-d/index.md +$dokka.location:com.highmobility.hmkitfleet.model/EligibilityStatus.ConnectivityStatus.UNKNOWN///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-connectivity-status/-u-n-k-n-o-w-n/index.md +$dokka.location:com.highmobility.hmkitfleet.model/EligibilityStatus.ConnectivityStatus///PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-connectivity-status/index.md +$dokka.location:com.highmobility.hmkitfleet.model/EligibilityStatus.ConnectivityStatus/entries/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-connectivity-status/entries.md +$dokka.location:com.highmobility.hmkitfleet.model/EligibilityStatus.ConnectivityStatus/valueOf/#kotlin.String/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-connectivity-status/value-of.md +$dokka.location:com.highmobility.hmkitfleet.model/EligibilityStatus.ConnectivityStatus/values/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-connectivity-status/values.md +$dokka.location:com.highmobility.hmkitfleet.model/EligibilityStatus.DataDelivery.PULL///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-data-delivery/-p-u-l-l/index.md +$dokka.location:com.highmobility.hmkitfleet.model/EligibilityStatus.DataDelivery.PUSH///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-data-delivery/-p-u-s-h/index.md +$dokka.location:com.highmobility.hmkitfleet.model/EligibilityStatus.DataDelivery///PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-data-delivery/index.md +$dokka.location:com.highmobility.hmkitfleet.model/EligibilityStatus.DataDelivery/entries/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-data-delivery/entries.md +$dokka.location:com.highmobility.hmkitfleet.model/EligibilityStatus.DataDelivery/valueOf/#kotlin.String/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-data-delivery/value-of.md +$dokka.location:com.highmobility.hmkitfleet.model/EligibilityStatus.DataDelivery/values/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-data-delivery/values.md +$dokka.location:com.highmobility.hmkitfleet.model/EligibilityStatus///PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/index.md +$dokka.location:com.highmobility.hmkitfleet.model/EligibilityStatus/EligibilityStatus/#kotlin.String#kotlin.Boolean#kotlin.collections.List[com.highmobility.hmkitfleet.model.EligibilityStatus.DataDelivery]#com.highmobility.hmkitfleet.model.EligibilityStatus.ConnectivityStatus?#kotlin.Boolean?/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/-eligibility-status.md +$dokka.location:com.highmobility.hmkitfleet.model/EligibilityStatus/connectivityStatus/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/connectivity-status.md +$dokka.location:com.highmobility.hmkitfleet.model/EligibilityStatus/dataDelivery/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/data-delivery.md +$dokka.location:com.highmobility.hmkitfleet.model/EligibilityStatus/eligible/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/eligible.md +$dokka.location:com.highmobility.hmkitfleet.model/EligibilityStatus/primaryUserAssigned/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/primary-user-assigned.md +$dokka.location:com.highmobility.hmkitfleet.model/EligibilityStatus/vin/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-eligibility-status/vin.md +$dokka.location:com.highmobility.hmkitfleet.model/Odometer.Length.KILOMETERS///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}hmkit-fleet/com.highmobility.hmkitfleet.model/-odometer/-length/-k-i-l-o-m-e-t-e-r-s/index.md +$dokka.location:com.highmobility.hmkitfleet.model/Odometer.Length.MILES///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}hmkit-fleet/com.highmobility.hmkitfleet.model/-odometer/-length/-m-i-l-e-s/index.md +$dokka.location:com.highmobility.hmkitfleet.model/Odometer.Length///PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-odometer/-length/index.md +$dokka.location:com.highmobility.hmkitfleet.model/Odometer.Length/entries/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-odometer/-length/entries.md +$dokka.location:com.highmobility.hmkitfleet.model/Odometer.Length/valueOf/#kotlin.String/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-odometer/-length/value-of.md +$dokka.location:com.highmobility.hmkitfleet.model/Odometer.Length/values/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-odometer/-length/values.md +$dokka.location:com.highmobility.hmkitfleet.model/Odometer///PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-odometer/index.md +$dokka.location:com.highmobility.hmkitfleet.model/Odometer/Odometer/#kotlin.Long#com.highmobility.hmkitfleet.model.Odometer.Length/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-odometer/-odometer.md +$dokka.location:com.highmobility.hmkitfleet.model/Odometer/unit/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-odometer/unit.md +$dokka.location:com.highmobility.hmkitfleet.model/Odometer/value/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-odometer/value.md +$dokka.location:com.highmobility.hmkitfleet.model/RequestClearanceResponse///PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-request-clearance-response/index.md +$dokka.location:com.highmobility.hmkitfleet.model/RequestClearanceResponse/RequestClearanceResponse/#kotlin.String#com.highmobility.hmkitfleet.model.ClearanceStatus.Status#kotlin.String?/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-request-clearance-response/-request-clearance-response.md +$dokka.location:com.highmobility.hmkitfleet.model/RequestClearanceResponse/description/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-request-clearance-response/description.md +$dokka.location:com.highmobility.hmkitfleet.model/RequestClearanceResponse/status/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-request-clearance-response/status.md +$dokka.location:com.highmobility.hmkitfleet.model/RequestClearanceResponse/vin/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.model/-request-clearance-response/vin.md +$dokka.location:com.highmobility.hmkitfleet.network////PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.network/index.md +$dokka.location:com.highmobility.hmkitfleet.network/Error///PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.network/-error/index.md +$dokka.location:com.highmobility.hmkitfleet.network/Error/Error/#kotlin.String#kotlin.String?#kotlin.String?/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.network/-error/-error.md +$dokka.location:com.highmobility.hmkitfleet.network/Error/detail/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.network/-error/detail.md +$dokka.location:com.highmobility.hmkitfleet.network/Error/source/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.network/-error/source.md +$dokka.location:com.highmobility.hmkitfleet.network/Error/title/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.network/-error/title.md +$dokka.location:com.highmobility.hmkitfleet.network/Response///PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.network/-response/index.md +$dokka.location:com.highmobility.hmkitfleet.network/Response/Response/#TypeParam(bounds=[kotlin.Any?])?#com.highmobility.hmkitfleet.network.Error?/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.network/-response/-response.md +$dokka.location:com.highmobility.hmkitfleet.network/Response/error/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.network/-response/error.md +$dokka.location:com.highmobility.hmkitfleet.network/Response/response/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet.network/-response/response.md +$dokka.location:com.highmobility.hmkitfleet////PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/index.md +$dokka.location:com.highmobility.hmkitfleet/HMKitConfiguration.Builder///PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/-builder/index.md +$dokka.location:com.highmobility.hmkitfleet/HMKitConfiguration.Builder/Builder/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/-builder/-builder.md +$dokka.location:com.highmobility.hmkitfleet/HMKitConfiguration.Builder/build/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/-builder/build.md +$dokka.location:com.highmobility.hmkitfleet/HMKitConfiguration.Builder/client/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/-builder/client.md +$dokka.location:com.highmobility.hmkitfleet/HMKitConfiguration.Builder/client/#okhttp3.OkHttpClient/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/-builder/client.md +$dokka.location:com.highmobility.hmkitfleet/HMKitConfiguration.Builder/credentials/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/-builder/credentials.md +$dokka.location:com.highmobility.hmkitfleet/HMKitConfiguration.Builder/credentials/#com.highmobility.hmkitfleet.HMKitCredentials/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/-builder/credentials.md +$dokka.location:com.highmobility.hmkitfleet/HMKitConfiguration.Builder/environment/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/-builder/environment.md +$dokka.location:com.highmobility.hmkitfleet/HMKitConfiguration.Builder/environment/#com.highmobility.hmkitfleet.HMKitFleet.Environment/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/-builder/environment.md +$dokka.location:com.highmobility.hmkitfleet/HMKitConfiguration///PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/index.md +$dokka.location:com.highmobility.hmkitfleet/HMKitConfiguration/client/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/client.md +$dokka.location:com.highmobility.hmkitfleet/HMKitConfiguration/credentials/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/credentials.md +$dokka.location:com.highmobility.hmkitfleet/HMKitConfiguration/environment/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-configuration/environment.md +$dokka.location:com.highmobility.hmkitfleet/HMKitCredentials.JwtProvider///PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-credentials/-jwt-provider/index.md +$dokka.location:com.highmobility.hmkitfleet/HMKitCredentials.JwtProvider/generateUuid/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-credentials/-jwt-provider/generate-uuid.md +$dokka.location:com.highmobility.hmkitfleet/HMKitCredentials.JwtProvider/getBaseUrl/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-credentials/-jwt-provider/get-base-url.md +$dokka.location:com.highmobility.hmkitfleet/HMKitCredentials.JwtProvider/getTimestamp/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-credentials/-jwt-provider/get-timestamp.md +$dokka.location:com.highmobility.hmkitfleet/HMKitCredentials///PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-credentials/index.md +$dokka.location:com.highmobility.hmkitfleet/HMKitCredentials/HMKitCredentials/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-credentials/-h-m-kit-credentials.md +$dokka.location:com.highmobility.hmkitfleet/HMKitFleet.Environment.Companion///PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/-environment/-companion/index.md +$dokka.location:com.highmobility.hmkitfleet/HMKitFleet.Environment.Companion/webUrl/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/-environment/-companion/web-url.md +$dokka.location:com.highmobility.hmkitfleet/HMKitFleet.Environment.PRODUCTION///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/-environment/-p-r-o-d-u-c-t-i-o-n/index.md +$dokka.location:com.highmobility.hmkitfleet/HMKitFleet.Environment.SANDBOX///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/-environment/-s-a-n-d-b-o-x/index.md +$dokka.location:com.highmobility.hmkitfleet/HMKitFleet.Environment///PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/-environment/index.md +$dokka.location:com.highmobility.hmkitfleet/HMKitFleet.Environment/entries/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/-environment/entries.md +$dokka.location:com.highmobility.hmkitfleet/HMKitFleet.Environment/valueOf/#kotlin.String/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/-environment/value-of.md +$dokka.location:com.highmobility.hmkitfleet/HMKitFleet.Environment/values/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/-environment/values.md +$dokka.location:com.highmobility.hmkitfleet/HMKitFleet///PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/index.md +$dokka.location:com.highmobility.hmkitfleet/HMKitFleet/HMKitFleet/#com.highmobility.hmkitfleet.HMKitConfiguration/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/-h-m-kit-fleet.md +$dokka.location:com.highmobility.hmkitfleet/HMKitFleet/deleteClearance/#kotlin.String/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/delete-clearance.md +$dokka.location:com.highmobility.hmkitfleet/HMKitFleet/getClearanceStatus/#kotlin.String/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/get-clearance-status.md +$dokka.location:com.highmobility.hmkitfleet/HMKitFleet/getClearanceStatuses/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/get-clearance-statuses.md +$dokka.location:com.highmobility.hmkitfleet/HMKitFleet/getEligibility/#kotlin.String#com.highmobility.hmkitfleet.model.Brand/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/get-eligibility.md +$dokka.location:com.highmobility.hmkitfleet/HMKitFleet/getVehicleState/#kotlin.String/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/get-vehicle-state.md +$dokka.location:com.highmobility.hmkitfleet/HMKitFleet/getVehicleStaticData/#kotlin.String/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/get-vehicle-static-data.md +$dokka.location:com.highmobility.hmkitfleet/HMKitFleet/requestClearance/#kotlin.String#com.highmobility.hmkitfleet.model.Brand#kotlin.collections.List[com.highmobility.hmkitfleet.model.ControlMeasure]?/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-fleet/request-clearance.md +$dokka.location:com.highmobility.hmkitfleet/HMKitOAuthCredentials///PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-o-auth-credentials/index.md +$dokka.location:com.highmobility.hmkitfleet/HMKitOAuthCredentials/HMKitOAuthCredentials/#kotlin.String#kotlin.String/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-o-auth-credentials/-h-m-kit-o-auth-credentials.md +$dokka.location:com.highmobility.hmkitfleet/HMKitOAuthCredentials/clientId/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-o-auth-credentials/client-id.md +$dokka.location:com.highmobility.hmkitfleet/HMKitOAuthCredentials/clientSecret/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-o-auth-credentials/client-secret.md +$dokka.location:com.highmobility.hmkitfleet/HMKitPrivateKeyCredentials///PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-private-key-credentials/index.md +$dokka.location:com.highmobility.hmkitfleet/HMKitPrivateKeyCredentials/HMKitPrivateKeyCredentials/#kotlin.String#kotlin.String#kotlin.String/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-private-key-credentials/-h-m-kit-private-key-credentials.md +$dokka.location:com.highmobility.hmkitfleet/HMKitPrivateKeyCredentials/clientId/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-private-key-credentials/client-id.md +$dokka.location:com.highmobility.hmkitfleet/HMKitPrivateKeyCredentials/privateKey/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-private-key-credentials/private-key.md +$dokka.location:com.highmobility.hmkitfleet/HMKitPrivateKeyCredentials/privateKeyId/#/PointingToDeclaration/hmkit-fleet/com.highmobility.hmkitfleet/-h-m-kit-private-key-credentials/private-key-id.md +com.highmobility.hmkitfleet +com.highmobility.hmkitfleet.model +com.highmobility.hmkitfleet.network + diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..e377e70 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,11 @@ +//[hmkit-fleet](index.md) + +# hmkit-fleet + +## Packages + +| Name | +|---| +| [com.highmobility.hmkitfleet](hmkit-fleet/com.highmobility.hmkitfleet/index.md) | +| [com.highmobility.hmkitfleet.model](hmkit-fleet/com.highmobility.hmkitfleet.model/index.md) | +| [com.highmobility.hmkitfleet.network](hmkit-fleet/com.highmobility.hmkitfleet.network/index.md) |