certcenter

type Approver struct {
	ApproverEmail string
	ApproverType  string `json:",omitempty"` // Domain or Generic
}

type ApproverListRequest struct {
	CommonName  string
	ProductCode string `json:",omitempty"`
	DNSNames    string `json:",omitempty"`
}

type ApproverListResult struct {
	BasicResultInfo
	// New approver information structure to
	// better implement BR 3.2.2.4 requirements
	DomainApprovers *DomainApprovers `json:",omitempty"`
	// Keep this legacy structure for backward compatibility reasons
	ApproverList []Approver `json:",omitempty"`
}

type BaseDomainRequest struct {
	FQDN string `json:"fqdn"`
}

type BaseDomainResult struct {
	FQDN   string `json:"fqdn"`
	Domain string `json:"domain"`
}

type BasicResultInfo struct {
	Success bool `json:"success"`
	Message string
	// if !Success, ErrorId and/or ErrorField may be provided
	ErrorId    int
	ErrorField string
	// Scheme validation results
	Msg string `json:"msg"`
	SchemeValidationErrors
}

type BillingInfo struct {
	Price      float32
	Currency   string
	Status     string
	InvoiceRef string // if available (Status == cleared)
}

type ConfigurationAssessment struct {
	Engine          string
	Ranking         string
	Effective       time.Time
	CriteriaVersion string
}

type Contact struct {
	Title               string               `json:",omitempty"`
	FirstName           string               `json:",omitempty"`
	LastName            string               `json:",omitempty"`
	OrganizationName    string               `json:",omitempty"`
	OrganizationAddress *OrganizationAddress `json:",omitempty"`
	Phone               string               `json:",omitempty"`
	Fax                 string               `json:",omitempty"`
	Email               string               `json:",omitempty"`
}

type ContactInfoPair struct {
	AdminContact Contact
	TechContact  Contact
}

type CreateUserRequest struct {
	UserData
}

type CreateUserResult struct {
	BasicResultInfo
	Id       int64
	FullName string
	Username string
	Roles    []string
}

type CreateVoucherRequest struct {
	OrderParameters OrderParameters
}

type CreateVoucherResult struct {
	BasicResultInfo
	VoucherCode     string
	OrderParameters OrderParameters
}

type DCVStatus struct {
	DomainControlValidationID int32
	Domain                    string
	Status                    string
	ApproverEmail             string
	LastCheckDate             time.Time
	LastUpdateDate            time.Time
}

type DNSAuthDetails struct {
	DNSEntry string
	DNSValue string
	Example  string
	FQDNs    []string
}

type DNSDataRequest struct {
	ProductCode string
	CSR         string
}

type DNSDataResult struct {
	BasicResultInfo
	DNSAuthDetails struct {
		PointerType string // =CNAME
		DNSEntry    string
		DNSValue    string
		Example     string
	}
}

type DeleteOrderRequest struct {
	CertCenterOrderID int64
}

type DeleteOrderResult struct {
	BasicResultInfo
}

type DeleteUserRequest struct {
	UsernameOrUserId string
}

type DeleteUserResult struct {
	BasicResultInfo
	Id int64
}

type DeleteVoucherRequest struct {
	VoucherCode string
}

type DeleteVoucherResult struct {
	OrderResult
}

type DomainApproverItem struct {
	Domain    string     `json:",omitempty"`
	Approvers []Approver `json:",omitempty"`
}

type DomainApprovers struct {
	DomainApprover []DomainApproverItem `json:",omitempty"`
}

type EmailAuthDetails struct {
	ApproverEmail       string
	ApproverNotifyDate  time.Time
	ApproverConfirmDate time.Time
}

type FileAuthDetails struct {
	FileContents string
	FileName     string
	FilePath     string
	PollStatus   string
	LastPollDate time.Time
	FQDNs        []string
}

type FileDataRequest struct {
	ProductCode string
	CSR         string
}

type FileDataResult struct {
	BasicResultInfo
	FileAuthDetails struct {
		FileContents string
		FileName     string
		FilePath     string
	}
}

type Fulfillment struct {
	StartDate     time.Time
	EndDate       time.Time
	CSR           string
	Certificate   string
	Intermediate  string
	DownloadLinks struct {
		Certificate  string
		Intermediate string
		IconScript   string
		PKCS7        string
	}
}

type GetModifiedOrdersRequest struct {
	FromDate                 time.Time
	ToDate                   time.Time
	IncludeFulfillment       bool `url:"includeFulfillment"`
	IncludeOrderParameters   bool `url:"includeOrderParameters"`
	IncludeBillingDetails    bool `url:"includeBillingDetails"`
	IncludeContacts          bool `url:"includeContacts"`
	IncludeOrganizationInfos bool `url:"includeOrganizationInfos"`
	IncludeDCVStatus         bool `url:"includeDCVStatus"`
}

type GetModifiedOrdersResult struct {
	OrderInfos []OrderInfo
	BasicResultInfo
}

type GetOrderRequest struct {
	CertCenterOrderID        int64
	IncludeFulfillment       bool `url:"includeFulfillment"`
	IncludeOrderParameters   bool `url:"includeOrderParameters"`
	IncludeBillingDetails    bool `url:"includeBillingDetails"`
	IncludeContacts          bool `url:"includeContacts"`
	IncludeOrganizationInfos bool `url:"includeOrganizationInfos"`
	IncludeDCVStatus         bool `url:"includeDCVStatus"`
}

type GetOrderResult struct {
	BasicResultInfo
	OrderInfo OrderInfo
}

type GetOrdersRequest struct {
	Status                   string
	ProductType              string
	CommonName               string
	IncludeFulfillment       bool `url:"includeFulfillment"`
	IncludeOrderParameters   bool `url:"includeOrderParameters"`
	IncludeBillingDetails    bool `url:"includeBillingDetails"`
	IncludeContacts          bool `url:"includeContacts"`
	IncludeOrganizationInfos bool `url:"includeOrganizationInfos"`
	IncludeDCVStatus         bool `url:"includeDCVStatus"`
}

type GetOrdersResult struct {
	BasicResultInfo
	OrderInfos []OrderInfo
	Meta       struct {
		ItemsAvailable int64
		ItemsPerPage   int64
		Page           int64
		OrderBy        string
		OrderDir       string
		Status         []string
		ProductType    []string
		CommonName     string
	} `json:"_meta"`
}

type GetUserRequest struct {
	UserData
}

type GetUserResult struct {
	BasicResultInfo
	Id int64
}

type GetVoucherRequest struct {
	VoucherCode string
}

type GetVouchersResult struct {
	BasicResultInfo
	Vouchers []struct {
		RedeemInfo struct {
			RedeemDate        time.Time
			CertCenterOrderID int64
		}
		CreationDate    time.Time
		OrderParameters OrderParameters
		VoucherCode     string
		Redeemed        bool
	}
}

type KeyValueStoreRequest struct {
	Key   string `json:"filename,omitempty"`
	Value string `json:"hash"`
}

type KeyValueStoreResult struct {
	Message string `json:"message"`
}

type LimitResult struct {
	BasicResultInfo
	LimitInfo struct {
		Limit float64
		Used  float64
	}
}

type OrderInfo struct {
	CertCenterOrderID       int64
	CommonName              string
	OrderStatus             OrderStatus
	ConfigurationAssessment ConfigurationAssessment
	BillingInfo             BillingInfo
	OrderParameters         OrderParameters
	ContactInfo             ContactInfoPair
	OrganizationInfo        OrganizationInfo
	Fulfillment             Fulfillment
	DNSAuthDetails          DNSAuthDetails
	FileAuthDetails         FileAuthDetails
	EmailAuthDetails        EmailAuthDetails
	DCVStatus               []DCVStatus
}

type OrderParameters struct {
	CSR                    string           `json:",omitempty"` // PEM-encoded PKCS#10
	IsCompetitiveUpgrade   bool             `json:",omitempty"`
	IsRenewal              bool             `json:",omitempty"`
	PartnerOrderID         string           `json:",omitempty"`
	ProductCode            string           `json:",omitempty"`
	ServerCount            int              `json:",omitempty"`
	SignatureHashAlgorithm string           `json:",omitempty"`
	SubjectAltNameCount    int              `json:",omitempty"`
	SubjectAltNames        []string         `json:",omitempty"`
	ValidityPeriod         int              `json:",omitempty"` // 12 or 24 month (days for AlwaysOnSSL, min. 180, max. 365)
	DVAuthMethod           string           `json:",omitempty"` // DNS, EMAIL, FILE
	DomainApprovers        *DomainApprovers `json:",omitempty"` // Domain Control Validation
	ApproverEmail          string           `json:",omitempty"` // deprecated
}

type OrderRequest struct {
	OrganizationInfo *OrganizationInfo `json:",omitempty"`
	OrderParameters  *OrderParameters  `json:",omitempty"`
	AdminContact     *Contact          `json:",omitempty"`
	TechContact      *Contact          `json:",omitempty"`
}

type OrderResult struct {
	BasicResultInfo
	Timestamp         time.Time
	CertCenterOrderID int64
	OrderParameters   struct {
		CSR                    string // PEM-encoded PKCS#10
		IsCompetitiveUpgrade   bool
		IsRenewal              bool
		PartnerOrderID         string
		ProductCode            string
		ServerCount            int
		SignatureHashAlgorithm string
		SubjectAltNameCount    int
		SubjectAltNames        []string
		ValidityPeriod         int    // 12 or 24 month (days for AlwaysOnSSL, min. 180, max. 365)
		DVAuthMethod           string // DNS, EMAIL, FILE
	}
	// AlwaysOnSSL (Encryption Everywhere) only:
	Fulfillment struct {
		Certificate  string
		PKCS7        string `json:"Certificate_PKCS7"`
		Intermediate string
	}
}

type OrderStatus struct {
	MajorStatus string
	MinorStatus string
	OrderDate   time.Time
	UpdateDate  time.Time
	StartDate   time.Time
	EndDate     time.Time
	Progress    int
}

type OrganizationAddress struct {
	AddressLine1 string `json:",omitempty"`
	PostalCode   string `json:",omitempty"`
	City         string `json:",omitempty"`
	Region       string `json:",omitempty"`
	Country      string `json:",omitempty"`
	Phone        string `json:",omitempty"`
	Fax          string `json:",omitempty"`
}

type OrganizationInfo struct {
	OrganizationName    string               `json:",omitempty"`
	OrganizationAddress *OrganizationAddress `json:",omitempty"`
}

type ProductDetailsRequest struct {
	ProductCode string
}

type ProductDetailsResult struct {
	BasicResultInfo
	ProductDetails struct {
		CA                string
		Currency          string
		Features          []string
		Licenses          int
		MaxValidityPeriod int
		Price             float64
		ProductCode       string
		ProductName       string
		RefundPeriod      int
		RenewPeriod       int
		SANFeatures       []string
		SANHostPrice      float64
		SANMaxHosts       int
		SANPackagePrice   float64
		SANPackageSize    int
	}
}

type ProductsResult struct {
	BasicResultInfo
	Products []string
}

type ProfileResult struct {
	AuthType        string
	AuthorizationID int64
	Country         string
	Currency        string
	CustomerID      int64
	Locale          string
	OAuth2Token     string `json:"OAuth2_Token"`
	Scope           string
	Timezone        string
}

type PutApproverEmailRequest struct {
	CertCenterOrderID int64
	ApproverEmail     string
}

type PutApproverEmailResult struct {
	BasicResultInfo
}

type QuoteRequest struct {
	ProductCode         string
	SubjectAltNameCount int
	ValidityPeriod      int
	ServerCount         int
}

type QuoteResult struct {
	BasicResultInfo
	Currency        string
	OrderParameters struct {
		ProductCode         string
		ServerCount         int
		SubjectAltNameCount int
		ValidityPeriod      int
	}
	Price float64
}

type RedeemVoucherRequest struct {
	VoucherCode      string
	OrganizationInfo *OrganizationInfo `json:",omitempty"`
	OrderParameters  *OrderParameters  `json:",omitempty"`
	AdminContact     *Contact          `json:",omitempty"`
	TechContact      *Contact          `json:",omitempty"`
}

type RedeemVoucherResult struct {
	OrderResult
}

type ReissueOrderParameters struct {
	CSR                    string
	DVAuthMethod           string
	SignatureHashAlgorithm string
	DomainApprovers        *DomainApprovers `json:",omitempty"` // Domain Control Validation
}

type ReissueRequest struct {
	CertCenterOrderID int64
	OrderParameters   ReissueOrderParameters
	ReissueEmail      string
}

type ReissueResult struct {
	BasicResultInfo
}

type ResendApproverEmailRequest struct {
	CertCenterOrderID int64
}

type ResendApproverEmailResult struct {
	BasicResultInfo
}

type RevokeRequest struct {
	CertCenterOrderID int64
	// optional parameters
	RevokeReason string `json:",omitempty"`
	Certificate  string `json:",omitempty"` // PEM encoded X.509 certificate
}

type RevokeResult struct {
	BasicResultInfo
}

type SchemeValidationErrors struct {
	Errors []struct {
		Msg    string `json:"msg"`
		Status string `json:"status"`
		Key    string `json:"key"`
		SchemeValidationErrors
	}
}

type UpdateUserRequest struct {
	UserData
}

type UpdateUserResult struct {
	BasicResultInfo
	Id int64
}

type UserAgreementRequest struct {
	ProductCode string
}

type UserAgreementResult struct {
	BasicResultInfo
	ProductCode   string
	UserAgreement string
}

type UserData struct {
	UsernameOrUserId string   `json:",omitempty"`
	FullName         string   `json:",omitempty"`
	Email            string   `json:",omitempty"`
	Username         string   `json:",omitempty"`
	Password         string   `json:",omitempty"`
	Roles            []string `json:",omitempty"`
	Mobile           string   `json:",omitempty"`
	Timezone         string   `json:",omitempty"`
	Locale           string   `json:",omitempty"`

	// Available on user data retrieval
	SpecialProductAvailability bool   `json:",omitempty"`
	Scope                      string `json:",omitempty"`
	Active                     bool   `json:",omitempty"`
	TwoFactorEnabled           bool   `json:",omitempty"`
	InsertDate                 int64  `json:",omitempty"` // Unix time
	LastUpdateDate             int64  `json:",omitempty"` // Unix time
	LastPasswordChangeDate     int64  `json:",omitempty"` // Unix time
}

type ValidateCSRRequest struct {
	CSR string // PEM-encoded PKCS#10
}

type ValidateCSRResult struct {
	BasicResultInfo
	ParsedCSR struct {
		CommonName             string
		Organization           string
		OrganizationUnit       string
		Email                  string
		State                  string
		Locality               string
		Country                string
		KeyLength              int
		SignaturAlgorithm      string
		KeyEncryptionAlgorithm string
		HashMD5                string
		HashSHA256             string
		UniqueValue            string
	}
}

type ValidateNameRequest struct {
	CommonName string
	// PLEASE DO NOT USE THIS FUNCTIONALITY IN PRODUCTIVE ENVIRONMENTS. THIS IS FOR TESTING PURPOSES ONLY.
	// WE STRONGLY RECOMMEND YOU TO GENERATE YOUR OWN PRIVATE KEYS TO ENSURE MAXIMUM SECURITY.
	GeneratePrivateKey bool
}

type ValidateNameResult struct {
	BasicResultInfo
	IsQualified bool
	// If ValidateNameRequest contained a GeneratePrivateKey=true
	// this two values are included in the result:
	CSR        string
	PrivateKey string
}

type VulnerabilityAssessmentRequest struct {
	CertCenterOrderID      int64
	ServiceStatus          string
	EmailNotificationLevel string
}

type VulnerabilityAssessmentRescanRequest struct {
	CertCenterOrderID int64
}

type VulnerabilityAssessmentRescanResult struct {
	BasicResultInfo
}

type VulnerabilityAssessmentResult struct {
	BasicResultInfo
}