/*
 * Copyright 2020 The Matrix.org Foundation C.I.C.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.matrix.android.sdk.internal.crypto.model.rest

import com.squareup.moshi.Json
import com.squareup.moshi.JsonClass
import org.matrix.android.sdk.api.util.JsonDict

/**
 * Ref: https://matrix.org/docs/spec/client_server/r0.6.1#post-matrix-client-r0-keys-upload
 */
@JsonClass(generateAdapter = true)
internal data class KeysUploadBody(
        /**
         * Identity keys for the device.
         *
         * May be absent if no new identity keys are required.
         */
        @Json(name = "device_keys")
        val deviceKeys: DeviceKeys? = null,

        /**
         * One-time public keys for "pre-key" messages. The names of the properties should be in the
         * format <algorithm>:<key_id>. The format of the key is determined by the key algorithm.
         *
         * May be absent if no new one-time keys are required.
         */
        @Json(name = "one_time_keys")
        val oneTimeKeys: JsonDict? = null,

        /**
         * If the user had previously uploaded a fallback key for a given algorithm, it is replaced.
         * The server will only keep one fallback key per algorithm for each user.
         */
        @Json(name = "fallback_keys")
        val fallbackKeys: JsonDict? = null
)
