https://github.com/ioki-mobility/kmp-passenger-api

Kotlin Multiplatform ioki Passenger API
https://github.com/ioki-mobility/kmp-passenger-api

Last synced: 13 days ago
JSON representation

Kotlin Multiplatform ioki Passenger API

• Host: GitHub
• URL: https://github.com/ioki-mobility/kmp-passenger-api
• Owner: ioki-mobility
• License: mit
• Created: 2024-08-06T11:20:19.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-12-21T06:14:05.000Z (15 days ago)
• Last Synced: 2024-12-22T18:13:39.818Z (14 days ago)
• Language: Kotlin
• Size: 231 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# KMP Passenger API

## Overview

The KMP Passenger API Library is an open-source Kotlin Multiplatform project

designed to provide a comprehensive suite of models and classes for interacting with the ioki passenger APIs.

Currenly supported platforms:

* Apple (iOS, macOS)

* JVM

* Android

## Features

- **Multiplatform Support**: Leverage the power of Kotlin Multiplatform to run your API interactions on any device.

- **Comprehensive Models**: Includes a wide range of pre-defined models for passenger data, making API requests simpler and more intuitive.

- **Easy API Requests**: Simplified classes and functions for making API requests, handling responses, and managing errors.

- **Open Source**: Freely available for use and contribution, fostering community improvements and enhancements.

## Getting Started

To include the KMP Passenger API Library in your project, add the following dependency to your `build.gradle.kts` file:

```kotlin

val commonMain by getting {

    dependencies {

        implementation("com.ioki:passenger-api:$currentVersion")

    }

}

```

Ensure you have the Kotlin Multiplatform plugin applied to your project:

```kotlin

plugins {

    kotlin("multiplatform")

}

```

## Usage

After including the library in your project, you first have to create an instance of the `IokiService` like the following:

```kotlin

val iokiService: IokiService = IokiService(

    baseUrl: String = "https://**.io.ki"

    requestHeaders: RequestHeaders = RequestHeaders(**)

    accessTokenProvider: AccessTokenProvider = InMemoryAccessTokenProvider()

    incerceptors: Set = setOf() // Optional

    timeOffsetProvider: TimeOffsetProvider = NoopTimeOffsetProvider // Optional

    logging: Logging? = { println(it) } // Optional

)

```

After that, you can communicate with it to make API calls:

```kotlin

val phoneNumber = ""

val request = ApiPhoneVerificationRequest(phoneNumber, null)

val phoneVerificationResult = iokiService.requestPhoneVerification(request)

```

The results of the API calls are wrapped into an `com.ioki.passenger.api.result.Result` class.

You can check if it was an `Sucess` or `Error` on it.

```kotlin

when(phoneVerificationResult) {

    is Result.Success -> { /* Do somehing with the success */ }

    is Result.Error -> { /* Do somehing with the error. Can also be an sub type of it like `Api`, `Generic`, and so on */ }

}

```

## Contribute

### Don't forget about local.properties

If you see this issue:

```

* What went wrong:

Could not determine the dependencies of task ':library:testDebugUnitTest'.

> SDK location not found. Define a valid SDK location with an ANDROID_HOME environment variable or by setting the sdk.dir path in your project's local properties file at '/Users/***/kmp-passenger-api/local.properties'.

```

Please provide the path to your Android SDK in the `local.properties` file in the root of the project. For example:

```

sdk.dir=/Users/***/Library/Android/sdk

```

## License

This project is licensed under the MIT License - see the [`LICENSE` file](LICENSE) for details.