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

//GlobalNamespace: 
//MakeDataContractsExtensible: False
//AddReturnMarker: True
//AddDescriptionAsComments: True
//AddDataContractAttributes: False
//AddIndexesToDataMembers: False
//AddGeneratedCodeAttributes: False
//AddResponseStatus: False
//AddImplicitVersion: 
//ExportValueTypes: False
IncludeTypes: GetClients.*
//ExcludeTypes: 
//InitializeCollections: True
//AddNamespaces: 
*)

namespace SanctionsSearch.Api2.ServiceModel.Operations.Base

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type Authentication() = 
        ///<summary>
        ///The API User ID provided by us when you signed up to use our API
        ///</summary>
        [<DataMember>]
        [<ApiMember(Description="The API User ID provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")>]
        member val ApiUserId:String = null with get,set

        ///<summary>
        ///The API User Key provided by us when you signed up to use our API
        ///</summary>
        [<DataMember>]
        [<ApiMember(Description="The API User Key provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")>]
        member val ApiUserKey:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseRequest() = 
        ///<summary>
        ///The authentication credentials
        ///</summary>
        [<DataMember>]
        [<ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")>]
        member val Authentication:Authentication = null with get,set

    [<AllowNullLiteral>]
    type IBaseRequest = 
        abstract Authentication:Authentication with get,set

    [<DataContract(Name="ClientState", Namespace="http://schemas.servicestack.net/types")>]
    type ClientState =
        | Undefined = 0
        | PendingCompletion = 1
        | PendingOcr = 2
        | PendingVerification = 3
        | Verified = 4

    [<DataContract>]
    [<AllowNullLiteral>]
    type PagedRequest() = 
        inherit BaseRequest()
        ///<summary>
        ///The maximum number of records to be returned in one page
        ///</summary>
        [<DataMember(Name="page[limit]")>]
        [<ApiMember(Description="The maximum number of records to be returned in one page", ParameterType="query")>]
        member val PageLimit:Int32 = new Int32() with get,set

        ///<summary>
        ///The starting point in the list of records from where the data should be fetched. Zero based index.
        ///</summary>
        [<DataMember(Name="page[offset]")>]
        [<ApiMember(Description="The starting point in the list of records from where the data should be fetched. Zero based index.", ParameterType="query")>]
        member val PageOffset:Int32 = new Int32() with get,set

        ///<summary>
        ///The term to determine the order in which the data is returned
        ///</summary>
        [<DataMember>]
        [<ApiMember(Description="The term to determine the order in which the data is returned", ParameterType="query")>]
        member val Sort:String = null with get,set

    [<AllowNullLiteral>]
    type Links() = 
        [<ApiMember>]
        member val Self:String = null with get,set

    [<AllowNullLiteral>]
    type Image() = 
        member val Id:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val OcrId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Url:String = null with get,set

    [<AllowNullLiteral>]
    type ClientShort() = 
        member val Id:Int32 = new Int32() with get,set
        member val DateCreated:DateTime = new DateTime() with get,set
        member val Name:String = null with get,set
        member val Reference:String = null with get,set
        member val IsValidateMe:Boolean = new Boolean() with get,set
        member val State:ClientState = new ClientState() with get,set
        member val Links:Links = null with get,set
        member val NumOfDocuments:Int32 = new Int32() with get,set
        member val Photo:Image = null with get,set

    [<AllowNullLiteral>]
    type ArrayOfClientShort() = 
        inherit ResizeArray<ClientShort>()

    [<AllowNullLiteral>]
    type GetClientsData() = 
        inherit PagedResponse<GetClients>()
        member val Clients:ArrayOfClientShort = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type GetClientsResponse() = 
        [<DataMember>]
        member val Data:GetClientsData = null with get,set

    [<Route("/clients", "GET")>]
    [<DataContract>]
    [<AllowNullLiteral>]
    type GetClients() = 
        inherit PagedRequest()
        interface IReturn<GetClientsResponse>
        ///<summary>
        ///Filter the results to those that have a State matching the state specified
        ///</summary>
        [<DataMember>]
        [<ApiMember(Description="Filter the results to those that have a State matching the state specified", ParameterType="query")>]
        member val State:ClientState = new ClientState() with get,set

        ///<summary>
        ///Filter the results to those that have a IsValidateMe flag matching the specified value
        ///</summary>
        [<DataMember>]
        [<ApiMember(Description="Filter the results to those that have a IsValidateMe flag matching the specified value", ParameterType="query")>]
        member val IsValidateMe:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        ///<summary>
        ///Filter the results to those that have a Name including the specified value
        ///</summary>
        [<DataMember>]
        [<ApiMember(Description="Filter the results to those that have a Name including the specified value", ParameterType="query")>]
        member val Name:String = null with get,set

        ///<summary>
        ///Filter the results to those that were created after (or on) this date
        ///</summary>
        [<DataMember>]
        [<ApiMember(Description="Filter the results to those that were created after (or on) this date", ParameterType="query")>]
        member val DateFrom:DateTime = new DateTime() with get,set

        ///<summary>
        ///Filter the results to those that were created before this date
        ///</summary>
        [<DataMember>]
        [<ApiMember(Description="Filter the results to those that were created before this date", ParameterType="query")>]
        member val DateTo:DateTime = new DateTime() with get,set

        ///<summary>
        ///If the searches are being accessed by a sub user, specify their username here to only return searches they have permissions to view
        ///</summary>
        [<DataMember>]
        [<ApiMember(Description="If the searches are being accessed by a sub user, specify their username here to only return searches they have permissions to view", ParameterType="query")>]
        member val SubUserName:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type ResponseError() = 
        [<DataMember(Order=1)>]
        member val ErrorCode:String = null with get,set

        [<DataMember(Order=2)>]
        member val FieldName:String = null with get,set

        [<DataMember(Order=3)>]
        member val Message:String = null with get,set

        [<DataMember(Order=4)>]
        member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set

    [<AllowNullLiteral>]
    type ArrayOfResponseError() = 
        inherit ResizeArray<ResponseError>()

    [<DataContract>]
    [<AllowNullLiteral>]
    type ResponseStatus() = 
        [<DataMember(Order=1)>]
        member val ErrorCode:String = null with get,set

        [<DataMember(Order=2)>]
        member val Message:String = null with get,set

        [<DataMember(Order=3)>]
        member val StackTrace:String = null with get,set

        [<DataMember(Order=4)>]
        member val Errors:ArrayOfResponseError = null with get,set

        [<DataMember(Order=5)>]
        member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set

    [<AllowNullLiteral>]
    type BaseResponse() = 
        ///<summary>
        ///The status of the response
        ///</summary>
        [<ApiMember(Description="The status of the response")>]
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type IBaseDataResponse = 
        abstract ResponseStatus:ResponseStatus with get,set

    [<AllowNullLiteral>]
    type IHasResponseStatus = 
        abstract ResponseStatus:ResponseStatus with get,set

    [<AllowNullLiteral>]
    type MetaLinks() = 
        inherit Links()
        ///<summary>
        ///The link to the first page of records
        ///</summary>
        [<ApiMember(Description="The link to the first page of records")>]
        member val First:String = null with get,set

        ///<summary>
        ///The link to the last page of records
        ///</summary>
        [<ApiMember(Description="The link to the last page of records")>]
        member val Last:String = null with get,set

        ///<summary>
        ///The link to the next page of records, if applicable
        ///</summary>
        [<ApiMember(Description="The link to the next page of records, if applicable")>]
        member val Next:String = null with get,set

        ///<summary>
        ///The link to the last page of records, if applicable
        ///</summary>
        [<ApiMember(Description="The link to the last page of records, if applicable")>]
        member val Prev:String = null with get,set

    [<AllowNullLiteral>]
    type Meta<T>() = 
        ///<summary>
        ///Pagination links
        ///</summary>
        [<ApiMember(Description="Pagination links")>]
        member val Links:MetaLinks = null with get,set

        ///<summary>
        ///The total number of records for the query
        ///</summary>
        [<ApiMember(Description="The total number of records for the query")>]
        member val TotalCount:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///The maximum number of records to be returned in one page
        ///</summary>
        [<ApiMember(Description="The maximum number of records to be returned in one page")>]
        member val PageLimit:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///The starting point in the list of records from where the data should be fetched. Zero based index.
        ///</summary>
        [<ApiMember(Description="The starting point in the list of records from where the data should be fetched. Zero based index.")>]
        member val PageOffset:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type PagedResponse<T>() = 
        inherit BaseResponse()
        ///<summary>
        ///The response Metadata
        ///</summary>
        [<ApiMember(Description="The response Metadata")>]
        member val Meta:Meta<T> = null with get,set