/* Options:
Date: 2025-03-15 03:13:48
Version: 8.30
Tip: To override a DTO option, remove "//" prefix before updating
BaseUrl: https://api.sanctionssearch.com/v2

//Package: 
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
IncludeTypes: GetPdfs.*
//ExcludeTypes: 
//InitializeCollections: True
//TreatTypesAsStrings: 
//DefaultImports: java.math.*,java.util.*,net.servicestack.client.*,com.google.gson.annotations.*,com.google.gson.reflect.*
*/

import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@Route(Path="/pdfs/list", Verbs="POST")
@DataContract
open class GetPdfs : BaseRequest(), IReturn<GetPdfsResponse>
{
    /**
    * The request data
    */
    @DataMember
    @ApiMember(Description="The request data", ParameterType="body")
    var request:GetPdfsRequest? = null
    companion object { private val responseType = GetPdfsResponse::class.java }
    override fun getResponseType(): Any? = GetPdfs.responseType
}

@DataContract
open class GetPdfsResponse
{
    /**
    * The response data
    */
    @DataMember
    @ApiMember(Description="The response data")
    @SerializedName("data") var Data:GetPdfsData? = null
}

@DataContract
open class Authentication
{
    /**
    * The API User ID provided by us when you signed up to use our API
    */
    @DataMember
    @ApiMember(Description="The API User ID provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
    var apiUserId:String? = null

    /**
    * The API User Key provided by us when you signed up to use our API
    */
    @DataMember
    @ApiMember(Description="The API User Key provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
    var apiUserKey:String? = null
}

@DataContract
open class BaseRequest : IBaseRequest
{
    /**
    * The authentication credentials
    */
    @DataMember
    @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
    var authentication:Authentication? = null
}

open interface IBaseRequest
{
    var authentication:Authentication?
}

open class GetPdfsRequest
{
    /**
    * If the saved documents are kept within a single Sub User account, specify their username here
    */
    @ApiMember(Description="If the saved documents are kept within a single Sub User account, specify their username here")
    var subUserName:String? = null
}

open class GetPdfsData : BaseResponse()
{
    /**
    * List of Documents, but not including the file data
    */
    @ApiMember(Description="List of Documents, but not including the file data")
    var documents:ArrayOfPdfDocument? = null
}

open class BaseResponse : IBaseDataResponse, IHasResponseStatus
{
    /**
    * The status of the response
    */
    @ApiMember(Description="The status of the response")
    var responseStatus:ResponseStatus? = null
}

open interface IBaseDataResponse
{
    var responseStatus:ResponseStatus?
}

open interface IHasResponseStatus
{
    var responseStatus:ResponseStatus?
}

open class ArrayOfPdfDocument : ArrayList<PdfDocument>()
{
}

open class ArrayOfResponseError : ArrayList<ResponseError>()
{
}

open class PdfDocument
{
    /**
    * The ID of the saved document
    */
    @ApiMember(Description="The ID of the saved document")
    var id:Long? = null

    /**
    * Is the document ready to download
    */
    @ApiMember(Description="Is the document ready to download")
    var isReady:Boolean? = null

    /**
    * The name of the saved document
    */
    @ApiMember(Description="The name of the saved document")
    var name:String? = null

    /**
    * The file name (including extension) of the saved document
    */
    @ApiMember(Description="The file name (including extension) of the saved document")
    var fileName:String? = null

    /**
    * The type of saved document (Human readable, pep, sanctions, validid, companylookup, etc.)
    */
    @ApiMember(Description="The type of saved document (Human readable, pep, sanctions, validid, companylookup, etc.)")
    @SerializedName("type") var Type:String? = null

    /**
    * If this document is a Saved Sanctions Search, the ID of the search it relates to
    */
    @ApiMember(Description="If this document is a Saved Sanctions Search, the ID of the search it relates to")
    var sanctionsSearchId:Long? = null

    /**
    * If this document is a Saved PEP Search, the ID of the search it relates to
    */
    @ApiMember(Description="If this document is a Saved PEP Search, the ID of the search it relates to")
    var pepSearchId:Long? = null

    /**
    * If this document is a Saved ValidID Search, the ID of the search it relates to
    */
    @ApiMember(Description="If this document is a Saved ValidID Search, the ID of the search it relates to")
    var validIdSearchId:Int? = null

    /**
    * If this document is a Saved CompanyLookup Search, the ID of the search it relates to
    */
    @ApiMember(Description="If this document is a Saved CompanyLookup Search, the ID of the search it relates to")
    var companyLookupSearchId:Int? = null

    /**
    * The date the saved document was created/requested
    */
    @ApiMember(Description="The date the saved document was created/requested")
    var dateCreated:Date? = null

    /**
    * The date the saved document will be no longer available. You can request a new document using the SaveSearch, SavePepSearch, etc. methods
    */
    @ApiMember(Description="The date the saved document will be no longer available. You can request a new document using the SaveSearch, SavePepSearch, etc. methods")
    var dateExpires:Date? = null
}