com.tink.rest.models.CreateCredentialsRequest.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rest Show documentation

A library for Tink core services

There is a newer version: 0.8.6

/**
 * NOTE: This class is auto generated by the Swagger Gradle Codegen for the following API: Tink API
 *
 * More info on this tool is available on https://github.com/Yelp/swagger-gradle-codegen
 */

package com.tink.rest.models

import com.squareup.moshi.Json
import com.squareup.moshi.JsonClass

/**
 * @property providerName The provider (financial institution) that the credentials is connected to.
 * @property fields This is a key-value map of `Field` name and value found on the `Provider` to which the credentials belongs to. This parameter is required when creating credentials.
 * @property callbackUri This URI will be used by the ASPSP to pass the authorization code. It corresponds to the redirect/callback URI in OAuth2/OpenId. This parameter is only applicable if you are a TPP.
 * @property appUri The end user will be redirected to this URI after the authorization code has been delivered.
 * @property triggerRefresh Defines if the Credentials creation should cause a refresh on aggregated data. Defaults to `true`
 */
@JsonClass(generateAdapter = true)
data class CreateCredentialsRequest(
    @Json(name = "providerName") @field:Json(name = "providerName") var providerName: String,
    @Json(name = "fields") @field:Json(name = "fields") var fields: Map,
    @Json(name = "callbackUri") @field:Json(name = "callbackUri") var callbackUri: String? = null,
    @Json(name = "appUri") @field:Json(name = "appUri") var appUri: String? = null,
    @Json(name = "triggerRefresh") @field:Json(name = "triggerRefresh") var triggerRefresh: Boolean? = null
)