PrivateCaptcha/pkg/api/response.go

package api

import "github.com/PrivateCaptcha/PrivateCaptcha/pkg/common"

type ResponseMetadata struct {
	Code        common.StatusCode `json:"code"`
	RequestID   string            `json:"request_id,omitempty"`
	Description string            `json:"description,omitempty"`
}

type APIResponse struct {
	Meta       ResponseMetadata `json:"meta"`
	Data       interface{}      `json:"data,omitempty"`
	Pagination *Pagination      `json:"pagination,omitempty"`
}

type Pagination struct {
	Page    int  `json:"page"`
	PerPage int  `json:"per_page"`
	HasMore bool `json:"has_more"`
}

type apiOrgInput struct {
	ID   string `json:"id,omitempty"`
	Name string `json:"name,omitempty"`
}

type apiOrgOutput struct {
	Name string `json:"name"`
	ID   string `json:"id"`
}

type apiOrgPropertyOutput struct {
	ID      string `json:"id"`
	Name    string `json:"name"`
	Sitekey string `json:"sitekey"`
}

type apiPropertySettings struct {
	Name            string `json:"name"`
	Level           int    `json:"level,omitempty"`
	Growth          string `json:"growth,omitempty"`
	ValiditySeconds int    `json:"validity_seconds,omitempty"`
	AllowSubdomains bool   `json:"allow_subdomains,omitempty"`
	AllowLocalhost  bool   `json:"allow_localhost,omitempty"`
	MaxReplayCount  int    `json:"max_replay_count,omitempty"`
}

type apiCreatePropertyInput struct {
	apiPropertySettings
	Domain string `json:"domain"`
}

type apiUpdatePropertyInput struct {
	apiPropertySettings
	ID string `json:"id"`
}

type operationResult struct {
	Code common.StatusCode `json:"code"`
}

type apiAsyncTaskOutput struct {
	ID string `json:"id"`
}

type apiAsyncTaskResultOutput struct {
	ID       string      `json:"id"`
	Finished bool        `json:"finished"`
	Result   interface{} `json:"result"`
}

type apiPropertyOutput struct {
	ID              string `json:"id"`
	Name            string `json:"name"`
	Domain          string `json:"domain"`
	Sitekey         string `json:"sitekey"`
	Level           int    `json:"level,omitempty"`
	Growth          string `json:"growth,omitempty"`
	ValiditySeconds int    `json:"validity_seconds,omitempty"`
	AllowSubdomains bool   `json:"allow_subdomains,omitempty"`
	AllowLocalhost  bool   `json:"allow_localhost,omitempty"`
	MaxReplayCount  int    `json:"max_replay_count,omitempty"`
}