resources

type Details json.RawMessage

type Flag struct {
	Name  string `json:"name"`
	Value int32  `json:"value"`
}

type Flagger interface {
	IsFlag() bool
}

type Flags struct {
	Mask   int32  `json:"mask"`
	Values []Flag `json:"flags"`
}

type Form struct {
	Key
	Attributes FormAttributes `json:"attributes"`
}

type FormAttributes struct {
	Address  string `json:"address"`
	Birthday string `json:"birthday"`
	Citizen  string `json:"citizen"`
	City     string `json:"city"`
	Country  string `json:"country"`
	// Form submission time. Unix time. Read-only.
	CreatedAt *int64 `json:"created_at,omitempty"`
	Email     string `json:"email"`
	IdNum     string `json:"id_num"`
	// base64 encoded image with max size 4 MB or URL for S3 storage with image up to 4 mb
	Image string `json:"image"`
	Name  string `json:"name"`
	// Time of the next possible form submission. Unix time. Read-only.
	NextFormAt *int64 `json:"next_form_at,omitempty"`
	// base64 encoded image with max size 4 MB or URL for S3 storage with image up to 4 mb
	PassportImage *string `json:"passport_image,omitempty"`
	Phone         string  `json:"phone"`
	Postal        string  `json:"postal"`
	// Form processing time. Absent if the status is accepted. Unix time. Read-only.
	ProcessedAt *int64 `json:"processed_at,omitempty"`
	Purpose     string `json:"purpose"`
	// Created - the empty form was created and now user can't use legacy submit Accepted - the data was saved by the service for further processing Processed - the data is processed and stored Read-only.
	Status  *string `json:"status,omitempty"`
	Surname string  `json:"surname"`
	// Time until the next form submission in seconds. Read-only.
	UntilNextForm *int64 `json:"until_next_form,omitempty"`
	Visited       string `json:"visited"`
}

type FormListResponse struct {
	Data     []Form          `json:"data"`
	Included Included        `json:"included"`
	Links    *Links          `json:"links"`
	Meta     json.RawMessage `json:"meta,omitempty"`
}

type FormResponse struct {
	Data     Form     `json:"data"`
	Included Included `json:"included"`
}

type ImageData struct {
	// Image size. It cannot be more than 4 megabytes.
	ContentLength int64 `json:"content_length"`
	// Allowed content-type is `image/png`, `image/jpeg` or `image/x-jp2`
	ContentType string `json:"content_type"`
}

type Included struct {
	// contains filtered or unexported fields
}

type Key struct {
	ID   string       `json:"id"`
	Type ResourceType `json:"type"`
}

type Links struct {
	First string `json:"first,omitempty"`
	Last  string `json:"last,omitempty"`
	Next  string `json:"next,omitempty"`
	Prev  string `json:"prev,omitempty"`
	Self  string `json:"self,omitempty"`
}

type Relation struct {
	Data  *Key   `json:"data,omitempty"`
	Links *Links `json:"links,omitempty"`
}

type RelationCollection struct {
	Data  []Key  `json:"data"`
	Links *Links `json:"links,omitempty"`
}

type Resource interface {
	//GetKey - returns key of the Resource
	GetKey() Key
}

type ResourceType string

type SubmitForm struct {
	Key
	Attributes SubmitFormAttributes `json:"attributes"`
}

type SubmitFormAttributes struct {
	Address string `json:"address"`
	// Date formated as DD/MM/YYYY
	Birthday string `json:"birthday"`
	Citizen  string `json:"citizen"`
	City     string `json:"city"`
	Country  string `json:"country"`
	Email    string `json:"email"`
	IdNum    string `json:"id_num"`
	// For default endpoint:   base64 encoded image with max size 4 MB; For lightweight endpoint:   link to the image in s3 storage;
	Image   string `json:"image"`
	Name    string `json:"name"`
	Phone   string `json:"phone"`
	Postal  string `json:"postal"`
	Purpose string `json:"purpose"`
	Surname string `json:"surname"`
	// Date formated as DD/MM/YYYY
	Visited string `json:"visited"`
}

type SubmitFormListRequest struct {
	Data     []SubmitForm    `json:"data"`
	Included Included        `json:"included"`
	Links    *Links          `json:"links"`
	Meta     json.RawMessage `json:"meta,omitempty"`
}

type SubmitFormRequest struct {
	Data     SubmitForm `json:"data"`
	Included Included   `json:"included"`
}

type UploadImage struct {
	Key
	Attributes UploadImageAttributes `json:"attributes"`
}

type UploadImageAttributes struct {
	// Image size. It cannot be more than 4 megabytes.
	ContentLength int64 `json:"content_length"`
	// Allowed content-type is `image/png` or `image/jpeg`
	ContentType string `json:"content_type"`
}

type UploadImageListRequest struct {
	Data     []UploadImage   `json:"data"`
	Included Included        `json:"included"`
	Links    *Links          `json:"links"`
	Meta     json.RawMessage `json:"meta,omitempty"`
}

type UploadImageRequest struct {
	Data     UploadImage `json:"data"`
	Included Included    `json:"included"`
}

type UploadImageResponse struct {
	Key
	Attributes UploadImageResponseAttributes `json:"attributes"`
}

type UploadImageResponseAttributes struct {
	// Pre-signed URL to upload the file
	Url string `json:"url"`
}

type UploadImageResponseListResponse struct {
	Data     []UploadImageResponse `json:"data"`
	Included Included              `json:"included"`
	Links    *Links                `json:"links"`
	Meta     json.RawMessage       `json:"meta,omitempty"`
}

type UploadImageResponseResponse struct {
	Data     UploadImageResponse `json:"data"`
	Included Included            `json:"included"`
}

type UploadImageResponseV2 struct {
	Key
	Attributes UploadImageResponseV2Attributes `json:"attributes"`
}

type UploadImageResponseV2Attributes struct {
	// Pre-signed URL to upload the file
	PassportImageUrl *string `json:"passport_image_url,omitempty"`
	// Pre-signed URL to upload the file
	SelfieImageUrl string `json:"selfie_image_url"`
}

type UploadImageResponseV2ListResponse struct {
	Data     []UploadImageResponseV2 `json:"data"`
	Included Included                `json:"included"`
	Links    *Links                  `json:"links"`
	Meta     json.RawMessage         `json:"meta,omitempty"`
}

type UploadImageResponseV2Response struct {
	Data     UploadImageResponseV2 `json:"data"`
	Included Included              `json:"included"`
}

type UploadImageV2 struct {
	Key
	Attributes UploadImageV2Attributes `json:"attributes"`
}

type UploadImageV2Attributes struct {
	PassportImage *ImageData `json:"passport_image,omitempty"`
	SelfieImage   ImageData  `json:"selfie_image"`
}

type UploadImageV2ListRequest struct {
	Data     []UploadImageV2 `json:"data"`
	Included Included        `json:"included"`
	Links    *Links          `json:"links"`
	Meta     json.RawMessage `json:"meta,omitempty"`
}

type UploadImageV2Request struct {
	Data     UploadImageV2 `json:"data"`
	Included Included      `json:"included"`
}