database

type Actor interface {
	GetPledges() ([]Pledge, error)
	AddPledges(pledgeIDs ...int) error
	UpdateMRV(MRV string)
	GetID() int
}

type Asset struct {
	Index      int
	Title      string
	Subtitle   string
	CompanyID  int
	Name       string
	Location   string
	State      string
	Type       string
	ActionType []string
	Capacity   float64

	Reports []ReportsByYear
}

type BucketItem interface {
	SetID(id int)
	GetID() int
	Save() error
}

type Certificate struct {
	ID            int
	CertificateID int
	Type          string
	Unit          string
	Status        string
}

type City struct {

	// Identifying info
	Index   int
	Name    string
	Region  string
	Country string

	// Contextual data
	Area        float64
	Iso         string
	Population  int
	Latitude    float64
	Longitude   float64
	Revenue     float64
	CompanySize int
	HQ          string

	MRV string

	Children []string

	Pledges []int

	Emissions  map[string]string // accept whatever emissions the frontend passes
	Mitigation map[string]string
	Adaptation map[string]string

	LastUpdated string
}

type ClimateReport struct {
	ID       int
	Name     string
	Scope    string
	Date     string
	Verified bool
	// contains filtered or unexported fields
}

type Company struct {

	// Identifying info
	Index       int
	Name        string `json:"shortname"`
	FullName    string `json:"name"`
	Description string `json:"description"`

	Locations      []Location           `json:"locations"`
	Accountability []DistributionRecord `json:"accountability"`

	Country string
	Address string

	UserIDs []int

	// Contextual data
	Area       float64
	Iso        string
	Population int
	// Latitude    float64
	// Longitude   float64
	Revenue     float64
	CompanySize int
	HQ          string

	MultiNational []string // an array of all the countries a company is in; if not an MNC, leave empty
	ForProfit     bool
	Industry      bool

	MRV string // the company's chosen MRV reporting methodology

	Pledges []int

	// Nested scopes
	States    []int
	Regions   []int
	Countries []int

	// The entity IDs of all the company's physical assets
	Assets []int

	// IDs of all the company's financial/regulatory assets (e.g. RECs, climate bonds, etc.)
	Certificates []Certificate

	ClimateReports []ClimateReport

	LastUpdated string
	Files       []string // list of ipfs hashes to be stored for verification or something similar
}

type ConnectRequest struct {
	Index   int
	DBName  string
	OrgName string

	DBActorTypes  []string // what type of actors does the DB cover?
	DBActionTypes []string // what type of actions does the DB track?

	ContactInfo string
	Links       []string // links with more info
}

type Country struct {

	// Identifying info
	Index       int
	Name        string `json:"name"`
	FullName    string `json:"full_name"`
	Description string `json:"description"`

	// Contextual data
	Area        float64
	Iso         string
	Population  int
	Latitude    float64
	Longitude   float64
	Revenue     float64
	CompanySize int
	HQ          string

	MRV string

	// For countries: children = regions
	Children       []string
	Credits        []int
	Pledges        []int                `json:"pledges"`
	Logo           string               `json:"logo"`
	Accountability []DistributionRecord `json:"accountability"`

	Emissions  map[string]string `json:"emissions"` // accept whatever emissions data the frontend passes
	Mitigation map[string]string
	Adaptation map[string]string

	LastUpdated string
	Files       []string // an a rray of all the necessary documents to validate this specific country
}

type DistributionRecord struct {
	Title  string
	Weight int
}

type EthWallet struct {
	EncryptedPrivateKey string
	PublicKey           string
	Address             string
}

type Location struct {
	Name            string
	Latitude        string
	Longitude       string
	NationStaeID    int
	RegionalStateID int
}

type Oversight struct {
	Index int
	Name  string

	UserIDs []int

	// options:
	// - "international organization"
	// - "UNFCCC Body"
	// - "Civil Society"
	// - "Financial Institution"
	// - "Research Organization"
	// - "Independent Reviewer"
	// - "Oracle System"
	OrgType string

	MRV string

	Scope  string // where does the actor operate?
	Weight int    // their weight, based on the organization's reputation

}

type Pledge struct {
	ID        int
	ActorType string
	ActorID   int
	Coop      bool

	/*
		Pledges can be:
		emissions reductions,
		mitigation actions (energy efficiency, renewables, etc.),
		or adaptation actions
	*/
	PledgeType string

	BaseYear float64

	TargetYear float64

	Goal float64

	// is this goal determined by a regulator, or voluntarily
	// adopted by the climate actor?
	Regulatory bool
}

type Region struct {

	// Identifying info
	Index   int
	Name    string
	Country string

	// Contextual data
	Area        float64
	Iso         string
	Population  int
	Latitude    float64
	Longitude   float64
	Revenue     float64
	CompanySize int
	HQ          string

	MRV string

	Pledges []int

	//	For regions: children = companies (divided by region)
	Children []string

	Emissions  map[string]string // accept whatever emissions the frontend passes
	Mitigation map[string]string
	Adaptation map[string]string

	LastUpdated string
}

type ReportsByYear struct {
	Year               int
	GWh                int
	MitigationOutcomes int
}

type State struct {

	// Identifying info
	Index   int
	Name    string
	Country string

	// Contextual data
	Area        float64
	Iso         string
	Population  int
	Latitude    float64
	Longitude   float64
	Revenue     float64
	CompanySize int
	HQ          string

	MRV string

	Pledges []int

	//	For states: children = companies (divided by state)
	Children []string

	Emissions  map[string]string // accept whatever emissions the frontend passes
	Mitigation map[string]string
	Adaptation map[string]string

	LastUpdated string
	Files       []string
}

type User struct {
	Index int

	FirstName string
	LastName  string
	Username  string
	Email     string
	Pwhash    string
	EIN       string

	AccessToken string // the access token used to authenticate with the platform for future requests

	EntityType string // choices are: individual, company, city, state, region, country, oversight
	EntityID   int    // index of the entity the user is associated with
	Verified   bool   // if the user is a verified member of the entity they purport to be a part of
	Admin      bool   // is the user an admin for its entity?

	EthereumWallet EthWallet
	Liked          []string // array of liked projects
	NotVisible     []string // array of visible projects

}