commonMain.com.xebia.functional.openai.generated.model.Upload.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xef-openai-client Show documentation
Building applications with LLMs through composability in Kotlin
The newest version!
/**
 *
 * Please note:
 * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * Do not edit this file manually.
 *
 */

@file:Suppress(
    "ArrayInDataClass",
    "EnumEntryName",
    "RemoveRedundantQualifierName",
    "UnusedImport"
)

package com.xebia.functional.openai.generated.model

import com.xebia.functional.openai.generated.model.OpenAIFile



import kotlinx.serialization.Serializable
import kotlinx.serialization.SerialName
import kotlinx.serialization.Contextual
import kotlin.js.JsName
import kotlinx.serialization.json.*

/**
* The Upload object can accept byte chunks in the form of Parts. 
*
    * @param id The Upload unique identifier, which can be referenced in API endpoints.
    * @param createdAt The Unix timestamp (in seconds) for when the Upload was created.
    * @param filename The name of the file to be uploaded.
    * @param bytes The intended number of bytes to be uploaded.
    * @param purpose The intended purpose of the file. [Please refer here](/docs/api-reference/files/object#files/object-purpose) for acceptable values.
    * @param status The status of the Upload.
    * @param expiresAt The Unix timestamp (in seconds) for when the Upload was created.
    * @param `object` The object type, which is always \"upload\".
    * @param file 
*/
@Serializable


data class Upload (
        /* The Upload unique identifier, which can be referenced in API endpoints. */
    @SerialName(value = "id") val id: kotlin.String,
        /* The Unix timestamp (in seconds) for when the Upload was created. */
    @SerialName(value = "created_at") val createdAt: kotlin.Int,
        /* The name of the file to be uploaded. */
    @SerialName(value = "filename") val filename: kotlin.String,
        /* The intended number of bytes to be uploaded. */
    @SerialName(value = "bytes") val bytes: kotlin.Int,
        /* The intended purpose of the file. [Please refer here](/docs/api-reference/files/object#files/object-purpose) for acceptable values. */
    @SerialName(value = "purpose") val purpose: kotlin.String,
        /* The status of the Upload. */
    @SerialName(value = "status") val status: Upload.Status,
        /* The Unix timestamp (in seconds) for when the Upload was created. */
    @SerialName(value = "expires_at") val expiresAt: kotlin.Int,
        /* The object type, which is always \"upload\". */
    @SerialName(value = "object") val `object`: Upload.`Object`? = null,
        @SerialName(value = "file") val file: OpenAIFile? = null
) {

            /**
            * The status of the Upload.
            *
            * Values: pending,completed,cancelled,expired
            */
            @Serializable
            enum class Status(val value: kotlin.String) {
                @SerialName(value = "pending") pending("pending"),
                @SerialName(value = "completed") completed("completed"),
                @SerialName(value = "cancelled") cancelled("cancelled"),
                @SerialName(value = "expired") expired("expired");
                }
            /**
            * The object type, which is always \"upload\".
            *
            * Values: upload
            */
            @Serializable
            enum class `Object`(val value: kotlin.String) {
                @SerialName(value = "upload") upload("upload");
                }
}