goft

package module
v0.4.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 26, 2025 License: MPL-2.0 Imports: 9 Imported by: 2

README

GoFt

Go Reference

Goft is a Go package that provides low level bindings to the 42 API. Sturcts are generated automaticly from the apidoc.

For help with this package or general Go discussion, please contact me on discord (sou.hoc).

Getting Started

Installing

This assumes you already have a working Go environment, if not please see this page first.

go get will always pull the latest tagged release from the master branch.

go get github.com/souhoc/goft
Usage

Import the package into your project.

import "github.com/souhoc/goft"

Construct a new fortytwo session which can be used to access the variety of 42 API endpoints. Here you can get a user

conf := clientcredentials.Config{
	ClientID:     "Your Client ID",
	ClientSecret: "Your Client Secret",
	TokenURL:     goft.TokenUrl,
	AuthStyle:    oauth2.AuthStyleInParams,
}
client := conf.Client(context.Background())
ft := goft.New(client)

var user goft.User
_, err := ft.Get("/users/" + login, &user)
if err != nil {
	return err
}

See Documentation and Examples below for more detailed information.

Documentation

NOTICE: This library and the 42 API are unfinished. Because of that there may be major changes to library in the future.

WIP

Examples

WIP

Troubleshooting

For help with common problems please open an issue

Contributing

Contributions are very welcomed, however please follow the below guidelines.

  • First open an issue describing the bug or enhancement so it can be discussed.
  • Try to match current naming conventions as closely as possible.
  • This package is intended to be a low level direct mapping of the Discord API, so please avoid adding enhancements outside of that scope without first discussing it.
  • Create a Pull Request with your changes against the master branch.

Documentation

Overview

Copyright (c) 2025 Souria-Saky HOCQUENGHEM

Index

Constants

View Source 
const (
	BaseURL = "https://api.intra.42.fr"

	Version          = "v2"
	BaseUrlVersioned = BaseURL + "/" + Version

	AuthURL  = BaseURL + "/oauth/authorize"
	TokenURL = BaseURL + "/oauth/token"
)

Variables

This section is empty.

Functions

func IsPisciner added in v0.4.0 

func IsPisciner(cursus []CursusUser) bool

Types

type Accreditation 

type Accreditation struct {
	CursusID  uint   `json:"cursus_id"`
	ID        uint   `json:"id"`
	Name      string `json:"name"`
	UserID    uint   `json:"user_id"`
	Validated bool   `json:"validated"`
}

type Achievement 

type Achievement struct {
	Achievements []any  `json:"achievements"`
	Description  string `json:"description"`
	ID           uint   `json:"id"`
	Image        string `json:"image"`
	Kind         string `json:"kind"`
	Name         string `json:"name"`
	NbrOfSuccess int    `json:"nbr_of_success"`
	Parent       any    `json:"parent"`
	Tier         string `json:"tier"`
	Title        any    `json:"title"`
	UsersURL     string `json:"users_url"`
	Visible      bool   `json:"visible"`
}

type AchievementUser 

type AchievementUser struct {
	CreatedAt time.Time `json:"created_at"`
	ID        uint      `json:"id"`
	Login     string    `json:"login"`
	URL       string    `json:"url"`
	UserID    uint      `json:"user_id"`
}

type Announcement 

type Announcement struct {
	Author    string    `json:"author"`
	CreatedAt time.Time `json:"created_at"`
	ExpireAt  time.Time `json:"expire_at"`
	ID        uint      `json:"id"`
	Kind      string    `json:"kind"`
	Link      any       `json:"link"`
	Text      string    `json:"text"`
	Title     string    `json:"title"`
	UpdatedAt time.Time `json:"updated_at"`
}

type App 

type App struct {
	CreatedAt   time.Time       `json:"created_at"`
	Description any             `json:"description"`
	ID          uint            `json:"id"`
	Image       any             `json:"image"`
	Name        string          `json:"name"`
	Owner       TransactionUser `json:"owner"`
	Public      bool            `json:"public"`
	RateLimit   int             `json:"rate_limit"`
	Roles       []Role          `json:"roles"`
	Scopes      []any           `json:"scopes"`
	UpdatedAt   time.Time       `json:"updated_at"`
	Website     any             `json:"website"`
}

type Attachment 

type Attachment struct {
	BaseID        uint          `json:"base_id"`
	CreatedAt     time.Time     `json:"created_at"`
	ID            uint          `json:"id"`
	Language      Language      `json:"language"`
	Name          string        `json:"name"`
	PageCount     int           `json:"page_count"`
	Pdf           AttachmentPdf `json:"pdf"`
	PdfProcessing bool          `json:"pdf_processing"`
	Slug          string        `json:"slug"`
	ThumbURL      any           `json:"thumb_url"`
	Type          string        `json:"type"`
	URL           any           `json:"url"`
}

type AttachmentPdf 

type AttachmentPdf struct {
	Pdf Pdf `json:"pdf"`
}

type Balance 

type Balance struct {
	BeginAt time.Time `json:"begin_at"`
	EndAt   time.Time `json:"end_at"`
	ID      uint      `json:"id"`
	PoolID  uint      `json:"pool_id"`
}

type BlocDeadlines 

type BlocDeadlines struct {
	BeginAt     time.Time `json:"begin_at"`
	BlocID      uint      `json:"bloc_id"`
	CoalitionID uint      `json:"coalition_id"`
	CreatedAt   time.Time `json:"created_at"`
	EndAt       time.Time `json:"end_at"`
	ID          uint      `json:"id"`
	UpdatedAt   time.Time `json:"updated_at"`
}

type Blocs 

type Blocs struct {
	CampusID   uint        `json:"campus_id"`
	Coalitions []Coalition `json:"coalitions"`
	CreatedAt  time.Time   `json:"created_at"`
	CursusID   uint        `json:"cursus_id"`
	ID         uint        `json:"id"`
	SquadSize  int         `json:"squad_size"`
	UpdatedAt  time.Time   `json:"updated_at"`
}

type Campus 

type Campus struct {
	Active             bool     `json:"active"`
	Address            string   `json:"address"`
	City               string   `json:"city"`
	Country            string   `json:"country"`
	DefaultHiddenPhone bool     `json:"default_hidden_phone"`
	EmailExtension     string   `json:"email_extension"`
	Endpoint           Endpoint `json:"endpoint"`
	Facebook           string   `json:"facebook"`
	ID                 uint     `json:"id"`
	Language           Language `json:"language"`
	Name               string   `json:"name"`
	Public             bool     `json:"public"`
	TimeZone           string   `json:"time_zone"`
	Twitter            string   `json:"twitter"`
	UsersCount         int      `json:"users_count"`
	VogsphereID        uint     `json:"vogsphere_id"`
	Website            string   `json:"website"`
	Zip                string   `json:"zip"`
}

type CampusUser 

type CampusUser struct {
	CampusID  uint `json:"campus_id"`
	ID        uint `json:"id"`
	IsPrimary bool `json:"is_primary"`
	UserID    uint `json:"user_id"`
}

type Close 

type Close struct {
	Closer            TransactionUser    `json:"closer"`
	CommunityServices []CommunityService `json:"community_services"`
	CreatedAt         time.Time          `json:"created_at"`
	EndAt             time.Time          `json:"end_at"`
	ID                uint               `json:"id"`
	Reason            string             `json:"reason"`
	State             string             `json:"state"`
	UpdatedAt         time.Time          `json:"updated_at"`
	User              TransactionUser    `json:"user"`
}

type Coalition 

type Coalition struct {
	Color    string `json:"color"`
	ID       uint   `json:"id"`
	ImageURL string `json:"image_url"`
	Name     string `json:"name"`
	Score    int    `json:"score"`
	Slug     string `json:"slug"`
	UserID   uint   `json:"user_id"`
}

type CoalitionsUser 

type CoalitionsUser struct {
	CoalitionID uint      `json:"coalition_id"`
	CreatedAt   time.Time `json:"created_at"`
	ID          uint      `json:"id"`
	UpdatedAt   time.Time `json:"updated_at"`
	UserID      uint      `json:"user_id"`
}

type CommunityService 

type CommunityService struct {
	Close      Close     `json:"close"`
	CreatedAt  time.Time `json:"created_at"`
	Duration   int       `json:"duration"`
	ID         uint      `json:"id"`
	Occupation string    `json:"occupation"`
	ScheduleAt time.Time `json:"schedule_at"`
	State      string    `json:"state"`
	UpdatedAt  time.Time `json:"updated_at"`
}

type Convention 

type Convention struct {
	Convention Thumb `json:"convention"`
}

type Cursus 

type Cursus struct {
	CreatedAt time.Time `json:"created_at"`
	ID        uint      `json:"id"`
	Name      string    `json:"name"`
	Slug      string    `json:"slug"`
}

type CursusUser 

type CursusUser struct {
	BeginAt      time.Time       `json:"begin_at"`
	Cursus       Cursus          `json:"cursus"`
	CursusID     uint            `json:"cursus_id"`
	EndAt        time.Time       `json:"end_at"`
	Grade        string          `json:"grade"`
	HasCoalition bool            `json:"has_coalition"`
	ID           uint            `json:"id"`
	Level        float32         `json:"level"`
	Skills       []any           `json:"skills"`
	User         TransactionUser `json:"user"`
}

type DasheUser 

type DasheUser struct {
	DashID    uint `json:"dash_id"`
	FinalMark any  `json:"final_mark"`
	ID        uint `json:"id"`
	RepoURL   any  `json:"repo_url"`
	RepoUUID  any  `json:"repo_uuid"`
	UserID    uint `json:"user_id"`
}

type Endpoint 

type Endpoint struct {
	Campus      []Campus  `json:"campus"`
	CreatedAt   time.Time `json:"created_at"`
	Description string    `json:"description"`
	ID          uint      `json:"id"`
	UpdatedAt   time.Time `json:"updated_at"`
	URL         string    `json:"url"`
}

type Entity 

type Entity struct {
	CreatedAt   time.Time `json:"created_at"`
	Description any       `json:"description"`
	ID          uint      `json:"id"`
	Image       any       `json:"image"`
	Name        string    `json:"name"`
	Owner       any       `json:"owner"`
	Public      bool      `json:"public"`
	RateLimit   int       `json:"rate_limit"`
	Scopes      []any     `json:"scopes"`
	UpdatedAt   time.Time `json:"updated_at"`
	Website     any       `json:"website"`
}

type Evaluation 

type Evaluation struct {
	ID   uint   `json:"id"`
	Kind string `json:"kind"`
}

type Event 

type Event struct {
	ID                        int       `json:"id"`
	Name                      string    `json:"name"`
	Description               string    `json:"description"`
	Location                  string    `json:"location"`
	Kind                      string    `json:"kind"`
	MaxPeople                 int       `json:"max_people"`
	NbrSubscribers            int       `json:"nbr_subscribers"`
	BeginAt                   time.Time `json:"begin_at"`
	EndAt                     time.Time `json:"end_at"`
	CampusIds                 []int     `json:"campus_ids"`
	CursusIds                 []int     `json:"cursus_ids"`
	CreatedAt                 time.Time `json:"created_at"`
	UpdatedAt                 time.Time `json:"updated_at"`
	ProhibitionOfCancellation int       `json:"prohibition_of_cancellation"`
	Waitlist                  Waitlist  `json:"waitlist,omitempty"`
}

func (Event) Dates 

func (e Event) Dates() string

func (Event) Duration 

func (e Event) Duration() time.Duration

func (Event) Short 

func (e Event) Short() string

Short does the same as String, but with less information

func (Event) ShortInfo 

func (e Event) ShortInfo() string

func (Event) String 

func (e Event) String() string

func (Event) Title 

func (e Event) Title() string

type Exam 

type Exam struct {
	BeginAt        time.Time `json:"begin_at"`
	Campus         Campus    `json:"campus"`
	CreatedAt      time.Time `json:"created_at"`
	Cursus         []Cursus  `json:"cursus"`
	EndAt          time.Time `json:"end_at"`
	ID             uint      `json:"id"`
	IPRange        string    `json:"ip_range"`
	Location       string    `json:"location"`
	MaxPeople      int       `json:"max_people"`
	Name           string    `json:"name"`
	NbrSubscribers int       `json:"nbr_subscribers"`
	Projects       []Project `json:"projects"`
	UpdatedAt      time.Time `json:"updated_at"`
}

type Expertise 

type Expertise struct {
	CreatedAt          time.Time `json:"created_at"`
	ExpertisesUsersURL string    `json:"expertises_users_url"`
	ID                 uint      `json:"id"`
	Kind               string    `json:"kind"`
	Name               string    `json:"name"`
	Slug               string    `json:"slug"`
	URL                string    `json:"url"`
}

type ExpertiseUser 

type ExpertiseUser struct {
	ContactMe   bool            `json:"contact_me"`
	CreatedAt   time.Time       `json:"created_at"`
	Expertise   Expertise       `json:"expertise"`
	ExpertiseID uint            `json:"expertise_id"`
	ID          uint            `json:"id"`
	Interested  bool            `json:"interested"`
	User        TransactionUser `json:"user"`
	UserID      uint            `json:"user_id"`
	Value       int             `json:"value"`
}

type FetchOptionFunc 

type FetchOptionFunc func(o *fetchOptions)

FetchOptionFunc is a function that configures fetchOptions.

func FetchWithTotal 

func FetchWithTotal(total int) FetchOptionFunc

FetchWithTotal sets the total number of items to fetch.

type Flag 

type Flag struct {
	CreatedAt time.Time `json:"created_at"`
	Icon      string    `json:"icon"`
	ID        uint      `json:"id"`
	Name      string    `json:"name"`
	Positive  bool      `json:"positive"`
	UpdatedAt time.Time `json:"updated_at"`
}

type FlashUser 

type FlashUser struct {
	EndAt   time.Time       `json:"end_at"`
	FlashID uint            `json:"flash_id"`
	ID      uint            `json:"id"`
	Seen    bool            `json:"seen"`
	User    TransactionUser `json:"user"`
}

type Flashe 

type Flashe struct {
	Content    string `json:"content"`
	Duration   int    `json:"duration"`
	ID         uint   `json:"id"`
	Identifier string `json:"identifier"`
	Selector   string `json:"selector"`
	Title      string `json:"title"`
}

type Group 

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

type GroupUser 

type GroupUser struct {
	CreatedAt time.Time `json:"created_at"`
	GroupID   uint      `json:"group_id"`
	ID        uint      `json:"id"`
	UpdatedAt time.Time `json:"updated_at"`
	UserID    uint      `json:"user_id"`
}

type Image 

type Image struct {
	Link     string        `json:"link"`
	Versions ImageVersions `json:"versions"`
}

type ImageVersions 

type ImageVersions struct {
	Large  string `json:"large"`
	Medium string `json:"medium"`
	Micro  string `json:"micro"`
	Small  string `json:"small"`
}

type Internship 

type Internship struct {
	AdministrationID         uint            `json:"administration_id"`
	BreachAt                 any             `json:"breach_at"`
	CompanyAddress           string          `json:"company_address"`
	CompanyBossUserEmail     string          `json:"company_boss_user_email"`
	CompanyBossUserFirstName string          `json:"company_boss_user_first_name"`
	CompanyBossUserLastName  string          `json:"company_boss_user_last_name"`
	CompanyBossUserPhone     string          `json:"company_boss_user_phone"`
	CompanyCity              string          `json:"company_city"`
	CompanyCountry           string          `json:"company_country"`
	CompanyName              string          `json:"company_name"`
	CompanyPostal            string          `json:"company_postal"`
	CompanySiret             string          `json:"company_siret"`
	CompanyUserEmail         string          `json:"company_user_email"`
	CompanyUserFirstName     string          `json:"company_user_first_name"`
	CompanyUserLastName      string          `json:"company_user_last_name"`
	CompanyUserPhone         string          `json:"company_user_phone"`
	CompanyUserPost          string          `json:"company_user_post"`
	ContractType             string          `json:"contract_type"`
	Convention               Convention      `json:"convention"`
	Currency                 string          `json:"currency"`
	Days                     string          `json:"days"`
	Duration                 int             `json:"duration"`
	EndAt                    time.Time       `json:"end_at"`
	ID                       uint            `json:"id"`
	InternshipAddress        string          `json:"internship_address"`
	InternshipCity           string          `json:"internship_city"`
	InternshipCountry        string          `json:"internship_country"`
	InternshipPostal         string          `json:"internship_postal"`
	LanguageID               uint            `json:"language_id"`
	Movement                 any             `json:"movement"`
	NbDays                   int             `json:"nb_days"`
	NbHours                  int             `json:"nb_hours"`
	OfferID                  any             `json:"offer_id"`
	Salary                   int             `json:"salary"`
	StartAt                  time.Time       `json:"start_at"`
	State                    string          `json:"state"`
	Subject                  string          `json:"subject"`
	User                     TransactionUser `json:"user"`
	UserAddress              string          `json:"user_address"`
	UserCity                 string          `json:"user_city"`
	UserCountry              string          `json:"user_country"`
	UserPostal               string          `json:"user_postal"`
}

type Language 

type Language struct {
	ID         uint   `json:"id"`
	Identifier string `json:"identifier"`
	Name       string `json:"name"`
}

type LanguageUser 

type LanguageUser struct {
	CreatedAt  time.Time `json:"created_at"`
	ID         uint      `json:"id"`
	LanguageID uint      `json:"language_id"`
	Position   int       `json:"position"`
	UserID     uint      `json:"user_id"`
}
type Link struct {
	First, Prev, Last, Next string
}
func ParseLink(rawLink string) Link

type Location 

type Location struct {
	BeginAt  time.Time       `json:"begin_at"`
	CampusID uint            `json:"campus_id"`
	EndAt    time.Time       `json:"end_at"`
	Floor    any             `json:"floor"`
	Host     string          `json:"host"`
	ID       uint            `json:"id"`
	Post     any             `json:"post"`
	Primary  bool            `json:"primary"`
	Row      any             `json:"row"`
	User     TransactionUser `json:"user"`
}

type Mailing 

type Mailing struct {
	Attachment  any       `json:"attachment"`
	Attachments any       `json:"attachments"`
	Bcc         []any     `json:"bcc"`
	Cc          []any     `json:"cc"`
	Content     string    `json:"content"`
	CreatedAt   time.Time `json:"created_at"`
	From        string    `json:"from"`
	HTMLContent string    `json:"html_content"`
	ID          uint      `json:"id"`
	Identifier  string    `json:"identifier"`
	Meta        Meta      `json:"meta"`
	Subject     string    `json:"subject"`
	Subtitle    any       `json:"subtitle"`
	Title       string    `json:"title"`
	To          []string  `json:"to"`
	UpdatedAt   time.Time `json:"updated_at"`
}

type Meta 

type Meta struct {
	Date      string `json:"date"`
	ID        uint   `json:"id"`
	Name      string `json:"name"`
	OtherUser string `json:"other_user"`
	User      string `json:"user"`
}

type Note 

type Note struct {
	Content   string          `json:"content"`
	CreatedAt time.Time       `json:"created_at"`
	FromUser  TransactionUser `json:"from_user"`
	ID        uint            `json:"id"`
	Subject   string          `json:"subject"`
	User      TransactionUser `json:"user"`
}

type Notion 

type Notion struct {
	CreatedAt  time.Time `json:"created_at"`
	Cursus     []Cursus  `json:"cursus"`
	ID         uint      `json:"id"`
	Name       string    `json:"name"`
	Slug       string    `json:"slug"`
	Subnotions []any     `json:"subnotions"`
	Tags       []Tag     `json:"tags"`
}

type Param 

type Param struct {
	CreatedAt    time.Time `json:"created_at"`
	DataType     string    `json:"data_type"`
	DefaultValue string    `json:"default_value"`
	ID           uint      `json:"id"`
	Name         string    `json:"name"`
	RuleID       uint      `json:"rule_id"`
	UpdatedAt    time.Time `json:"updated_at"`
}

type Partnership 

type Partnership struct {
	ID                   uint   `json:"id"`
	Name                 string `json:"name"`
	PartnershipsUsersURL string `json:"partnerships_users_url"`
	Slug                 string `json:"slug"`
	Tier                 int    `json:"tier"`
	URL                  string `json:"url"`
}

type PartnershipUser 

type PartnershipUser struct {
	FinalMark     any             `json:"final_mark"`
	ID            uint            `json:"id"`
	PartnershipID uint            `json:"partnership_id"`
	User          TransactionUser `json:"user"`
}

type Patronage 

type Patronage struct {
	CreatedAt   time.Time       `json:"created_at"`
	Godfather   TransactionUser `json:"godfather"`
	GodfatherID uint            `json:"godfather_id"`
	ID          uint            `json:"id"`
	Ongoing     bool            `json:"ongoing"`
	UpdatedAt   time.Time       `json:"updated_at"`
	User        TransactionUser `json:"user"`
	UserID      uint            `json:"user_id"`
}

type PatronageReport 

type PatronageReport struct {
	Answers     []any           `json:"answers"`
	BeginAt     time.Time       `json:"begin_at"`
	CreatedAt   time.Time       `json:"created_at"`
	ID          uint            `json:"id"`
	Patronage   Patronage       `json:"patronage"`
	PatronageID uint            `json:"patronage_id"`
	Report      Report          `json:"report"`
	ReportID    uint            `json:"report_id"`
	UpdatedAt   time.Time       `json:"updated_at"`
	User        TransactionUser `json:"user"`
	UserID      uint            `json:"user_id"`
	ValidatedAt time.Time       `json:"validated_at"`
}

type Pdf 

type Pdf struct {
	Thumb Thumb `json:"thumb"`
	URL   any   `json:"url"`
}

type Pool 

type Pool struct {
	CampusID      uint `json:"campus_id"`
	CurrentPoints int  `json:"current_points"`
	CursusID      uint `json:"cursus_id"`
	ID            uint `json:"id"`
	MaxPoints     int  `json:"max_points"`
}

type Product 

type Product struct {
	BeginAt         time.Time    `json:"begin_at"`
	CategoryID      uint         `json:"category_id"`
	CreatedAt       time.Time    `json:"created_at"`
	Description     string       `json:"description"`
	EndAt           time.Time    `json:"end_at"`
	ID              uint         `json:"id"`
	Image           ProductImage `json:"image"`
	IsUniq          bool         `json:"is_uniq"`
	Kind            string       `json:"kind"`
	Name            string       `json:"name"`
	OneTimePurchase bool         `json:"one_time_purchase"`
	Price           int          `json:"price"`
	Quantity        int          `json:"quantity"`
	Slug            string       `json:"slug"`
	UpdatedAt       time.Time    `json:"updated_at"`
}

type ProductImage 

type ProductImage struct {
	Thumb Thumb  `json:"thumb"`
	URL   string `json:"url"`
}

type Project 

type Project struct {
	Attachments     []any            `json:"attachments"`
	Campus          []UserCampus     `json:"campus"`
	Children        []any            `json:"children"`
	CreatedAt       time.Time        `json:"created_at"`
	Cursus          []Cursus         `json:"cursus"`
	Description     string           `json:"description"`
	Difficulty      int              `json:"difficulty"`
	Exam            bool             `json:"exam"`
	ID              uint             `json:"id"`
	Name            string           `json:"name"`
	Objectives      []string         `json:"objectives"`
	Parent          any              `json:"parent"`
	ProjectSessions []ProjectSession `json:"project_sessions"`
	Skills          []Skill          `json:"skills"`
	Slug            string           `json:"slug"`
	Tags            []Tag            `json:"tags"`
	UpdatedAt       time.Time        `json:"updated_at"`
	Videos          []any            `json:"videos"`
}

type ProjectData 

type ProjectData struct {
	By               []any  `json:"by"`
	Coordinates      []int  `json:"coordinates"`
	ID               uint   `json:"id"`
	Kind             string `json:"kind"`
	ProjectSessionID uint   `json:"project_session_id"`
}

type ProjectSession 

type ProjectSession struct {
	BeginAt          time.Time    `json:"begin_at"`
	Campus           any          `json:"campus"`
	CampusID         any          `json:"campus_id"`
	CreatedAt        time.Time    `json:"created_at"`
	Cursus           any          `json:"cursus"`
	CursusID         any          `json:"cursus_id"`
	DurationDays     any          `json:"duration_days"`
	EndAt            time.Time    `json:"end_at"`
	EstimateTime     int          `json:"estimate_time"`
	Evaluations      []Evaluation `json:"evaluations"`
	ID               uint         `json:"id"`
	IsSubscriptable  bool         `json:"is_subscriptable"`
	MaxPeople        any          `json:"max_people"`
	Project          Project      `json:"project"`
	ProjectID        uint         `json:"project_id"`
	Scales           []Scale      `json:"scales"`
	Solo             bool         `json:"solo"`
	TeamBehaviour    string       `json:"team_behaviour"`
	TerminatingAfter any          `json:"terminating_after"`
	UpdatedAt        time.Time    `json:"updated_at"`
	Uploads          []any        `json:"uploads"`
}

type ProjectSessionSkill 

type ProjectSessionSkill struct {
	CreatedAt        time.Time `json:"created_at"`
	ID               uint      `json:"id"`
	ProjectSessionID uint      `json:"project_session_id"`
	SkillID          uint      `json:"skill_id"`
	UpdatedAt        time.Time `json:"updated_at"`
	Value            int       `json:"value"`
}

type ProjectUser 

type ProjectUser struct {
	CurrentTeamID uint            `json:"current_team_id"`
	CursusIds     []int           `json:"cursus_ids"`
	FinalMark     any             `json:"final_mark"`
	ID            uint            `json:"id"`
	Occurrence    int             `json:"occurrence"`
	Project       Project         `json:"project"`
	Status        string          `json:"status"`
	Teams         []Team          `json:"teams"`
	User          TransactionUser `json:"user"`
	Validated     any             `json:"validated?"`
}

type Quest 

type Quest struct {
	Campus       any       `json:"campus"`
	CampusID     any       `json:"campus_id"`
	CreatedAt    time.Time `json:"created_at"`
	Cursus       Cursus    `json:"cursus"`
	CursusID     uint      `json:"cursus_id"`
	Description  string    `json:"description"`
	Grade        any       `json:"grade"`
	GradeID      any       `json:"grade_id"`
	ID           uint      `json:"id"`
	InternalName any       `json:"internal_name"`
	Kind         string    `json:"kind"`
	Name         string    `json:"name"`
	Position     int       `json:"position"`
	Slug         string    `json:"slug"`
	UpdatedAt    time.Time `json:"updated_at"`
}

type QuestUser 

type QuestUser struct {
	Advancement any             `json:"advancement"`
	CreatedAt   time.Time       `json:"created_at"`
	EndAt       time.Time       `json:"end_at"`
	ID          uint            `json:"id"`
	Prct        any             `json:"prct"`
	Quest       Quest           `json:"quest"`
	QuestID     uint            `json:"quest_id"`
	UpdatedAt   time.Time       `json:"updated_at"`
	User        TransactionUser `json:"user"`
	ValidatedAt time.Time       `json:"validated_at"`
}

type Question 

type Question struct {
	CreatedAt  time.Time `json:"created_at"`
	Guidelines string    `json:"guidelines"`
	ID         uint      `json:"id"`
	Kind       string    `json:"kind"`
	Name       string    `json:"name"`
	Rating     string    `json:"rating"`
}

type Report 

type Report struct {
	Comment        string    `json:"comment"`
	CreatedAt      time.Time `json:"created_at"`
	DelayDays      int       `json:"delay_days"`
	DisclaimerMd   string    `json:"disclaimer_md"`
	GuidelinesMd   string    `json:"guidelines_md"`
	ID             uint      `json:"id"`
	IntroductionMd string    `json:"introduction_md"`
	Name           string    `json:"name"`
	Slug           string    `json:"slug"`
	UpdatedAt      time.Time `json:"updated_at"`
}

type Resources_sub100 

type Resources_sub100 struct {
	Description any    `json:"description"`
	Name        string `json:"name"`
}

type Resources_sub101 

type Resources_sub101 struct {
	Description string `json:"description"`
	Name        string `json:"name"`
}

type Resources_sub102 

type Resources_sub102 struct {
	CreatedAt          time.Time        `json:"created_at"`
	FieldsOrganisation Resources_sub101 `json:"fields_organisation"`
	ID                 uint             `json:"id"`
	IdentifiedBy       []string         `json:"identified_by"`
	SearchableBy       []string         `json:"searchable_by"`
	StructuresKind     string           `json:"structures_kind"`
	TypeName           string           `json:"type_name"`
	UpToDate           bool             `json:"up_to_date"`
	UpdatedAt          time.Time        `json:"updated_at"`
}

type Resources_sub105 

type Resources_sub105 struct {
	BeginAt      time.Time       `json:"begin_at"`
	Cursus       Cursus          `json:"cursus"`
	CursusID     uint            `json:"cursus_id"`
	EndAt        time.Time       `json:"end_at"`
	Grade        any             `json:"grade"`
	HasCoalition bool            `json:"has_coalition"`
	ID           uint            `json:"id"`
	Level        float32         `json:"level"`
	Skills       []any           `json:"skills"`
	User         TransactionUser `json:"user"`
}

type Resources_sub106 

type Resources_sub106 struct {
	ContactMe   bool      `json:"contact_me"`
	CreatedAt   time.Time `json:"created_at"`
	ExpertiseID uint      `json:"expertise_id"`
	ID          uint      `json:"id"`
	Interested  bool      `json:"interested"`
	UserID      uint      `json:"user_id"`
	Value       int       `json:"value"`
}

type Role 

type Role struct {
	Description string `json:"description"`
	ID          uint   `json:"id"`
	Name        string `json:"name"`
}

type RoleEntity 

type RoleEntity struct {
	CreatedAt  time.Time `json:"created_at"`
	Entity     Entity    `json:"entity"`
	EntityID   uint      `json:"entity_id"`
	EntityType string    `json:"entity_type"`
	ExpiresAt  time.Time `json:"expires_at"`
	ID         uint      `json:"id"`
	Role       Role      `json:"role"`
}

type Rule 

type Rule struct {
	CreatedAt            time.Time `json:"created_at"`
	Description          string    `json:"description"`
	ID                   uint      `json:"id"`
	InternalName         string    `json:"internal_name"`
	Kind                 string    `json:"kind"`
	Name                 string    `json:"name"`
	Params               []Param   `json:"params"`
	ProjectSessionsRules []any     `json:"project_sessions_rules"`
	Slug                 string    `json:"slug"`
	UpdatedAt            time.Time `json:"updated_at"`
}

type Scale 

type Scale struct {
	Comment            string     `json:"comment"`
	CorrectionNumber   int        `json:"correction_number"`
	CreatedAt          time.Time  `json:"created_at"`
	DisclaimerMd       string     `json:"disclaimer_md"`
	Duration           int        `json:"duration"`
	Evaluation         Evaluation `json:"evaluation"`
	EvaluationID       uint       `json:"evaluation_id"`
	GuidelinesMd       string     `json:"guidelines_md"`
	ID                 uint       `json:"id"`
	IntroductionMd     string     `json:"introduction_md"`
	IsPrimary          bool       `json:"is_primary"`
	Languages          []Language `json:"languages"`
	ManualSubscription bool       `json:"manual_subscription"`
	Name               string     `json:"name"`
	Sections           []Section  `json:"sections"`
}

type ScaleTeam 

type ScaleTeam struct {
	BeginAt        time.Time       `json:"begin_at"`
	Comment        any             `json:"comment"`
	Correcteds     []ScaleTeamUser `json:"correcteds"`
	Corrector      ScaleTeamUser   `json:"corrector"`
	CreatedAt      time.Time       `json:"created_at"`
	Feedback       any             `json:"feedback"`
	FeedbackRating any             `json:"feedback_rating"`
	Feedbacks      []any           `json:"feedbacks"`
	FilledAt       time.Time       `json:"filled_at"`
	FinalMark      int             `json:"final_mark"`
	Flag           Flag            `json:"flag"`
	ID             uint            `json:"id"`
	Team           Team            `json:"team"`
	Scale          Scale           `json:"scale"`
	ScaleID        uint            `json:"scale_id"`
	Truant         any             `json:"truant"`
	UpdatedAt      time.Time       `json:"updated_at"`
}

type ScaleTeamUser added in v0.3.1 

type ScaleTeamUser struct {
	ID    int    `json:"id"`
	Login string `json:"login"`
	URL   string `json:"url"`
}

type Score 

type Score struct {
	CalculationID    uint      `json:"calculation_id"`
	CoalitionID      uint      `json:"coalition_id"`
	CoalitionsUserID uint      `json:"coalitions_user_id"`
	CreatedAt        time.Time `json:"created_at"`
	ID               uint      `json:"id"`
	Reason           string    `json:"reason"`
	ScoreableID      uint      `json:"scoreable_id"`
	ScoreableType    string    `json:"scoreable_type"`
	UpdatedAt        time.Time `json:"updated_at"`
	Value            int       `json:"value"`
}

type Section 

type Section struct {
	Description string     `json:"description"`
	ID          uint       `json:"id"`
	Name        string     `json:"name"`
	Questions   []Question `json:"questions"`
}

type Session 

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

Session represents a session for interacting with the 42 school API. It manages rate limiting and provides methods to perform HTTP requests.

func New 

func New(client *http.Client) *Session

New creates a new Session with the provided HTTP client. It initializes rate limiters to control the frequency of API requests.

func (*Session) Do 

func (s *Session) Do(req *http.Request) (*http.Response, error)

Do performs an HTTP request using the session's client. It waits for the rate limiters and handles the Authorization header.

func (*Session) Fetch 

func (s *Session) Fetch(uri string, v any, opts ...FetchOptionFunc) (*http.Response, error)

Fetch performs a GET request to the specified URI and decodes the JSON response into v. It handles paginated responses and accumulates the results.

Example usage: 

var events []model.Event
Session.Fetch("/events", &events, FetchWithTotal(100))

func (*Session) Get 

func (s *Session) Get(uri string, v any) (*http.Response, error)

Get performs a GET request to the specified URI and decodes the JSON response into v. It prepends the API base URL to the URI and waits for the rate limiters.

Example usage: 

var events []model.Event
Session.Get("/events", &events)

type Skill 

type Skill struct {
	CreatedAt time.Time `json:"created_at"`
	ID        uint      `json:"id"`
	Name      string    `json:"name"`
}

type Subnotion 

type Subnotion struct {
	Attachments []any     `json:"attachments"`
	CreatedAt   time.Time `json:"created_at"`
	ID          uint      `json:"id"`
	Name        string    `json:"name"`
	Notepad     any       `json:"notepad"`
	Notion      any       `json:"notion"`
	Slug        string    `json:"slug"`
}

type Tag 

type Tag struct {
	ID         uint   `json:"id"`
	Kind       string `json:"kind"`
	Name       string `json:"name"`
	Subnotions []any  `json:"subnotions"`
	Users      []any  `json:"users"`
}

type Team 

type Team struct {
	Closed           bool      `json:"closed?"`
	ClosedAt         time.Time `json:"closed_at"`
	CreatedAt        time.Time `json:"created_at"`
	FinalMark        int       `json:"final_mark"`
	ID               uint      `json:"id"`
	Locked           bool      `json:"locked?"`
	LockedAt         time.Time `json:"locked_at"`
	Name             string    `json:"name"`
	ProjectID        uint      `json:"project_id"`
	ProjectSessionID uint      `json:"project_session_id"`
	RepoURL          string    `json:"repo_url"`
	RepoUUID         string    `json:"repo_uuid"`
	Status           string    `json:"status"`
	TerminatingAt    time.Time `json:"terminating_at"`
	UpdatedAt        time.Time `json:"updated_at"`
	URL              string    `json:"url"`
	Users            []User    `json:"users"`
	Validated        bool      `json:"validated?"`
}

type TeamUpload 

type TeamUpload struct {
	Comment   string    `json:"comment"`
	CreatedAt time.Time `json:"created_at"`
	FinalMark int       `json:"final_mark"`
	ID        uint      `json:"id"`
	Upload    Upload    `json:"upload"`
	UploadID  uint      `json:"upload_id"`
}

type TeamUser 

type TeamUser struct {
	CreatedAt  time.Time       `json:"created_at"`
	ID         uint            `json:"id"`
	Leader     bool            `json:"leader"`
	Occurrence int             `json:"occurrence"`
	Team       Team            `json:"team"`
	TeamID     uint            `json:"team_id"`
	User       TransactionUser `json:"user"`
	UserID     uint            `json:"user_id"`
	Validated  bool            `json:"validated"`
}

type Theme 

type Theme struct {
	CreatedAt time.Time `json:"created_at"`
	ID        uint      `json:"id"`
	Name      string    `json:"name"`
	UpdatedAt time.Time `json:"updated_at"`
}

type Thumb 

type Thumb struct {
	URL string `json:"url"`
}

type Title 

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

type TitleUser 

type TitleUser struct {
	ID        int       `json:"id"`
	UserId    int       `json:"user_id"`
	TitleId   int       `json:"title_id"`
	Selected  bool      `json:"selected"`
	CreatedAt time.Time `json:"created_at"`
	UpdatedAt time.Time `json:"updated_at"`
}

type Transaction 

type Transaction struct {
	ID               uint            `json:"id"`
	Reason           string          `json:"reason"`
	TransactableID   uint            `json:"transactable_id"`
	TransactableType string          `json:"transactable_type"`
	User             TransactionUser `json:"user"`
	UserID           uint            `json:"user_id"`
	Value            int             `json:"value"`
}

type TransactionUser 

type TransactionUser struct {
	ID    uint   `json:"id"`
	Login string `json:"login"`
	URL   string `json:"url"`
}

type Translation 

type Translation struct {
	CreatedAt               time.Time        `json:"created_at"`
	Default                 bool             `json:"default"`
	Fields                  Resources_sub100 `json:"fields"`
	ID                      uint             `json:"id"`
	LanguageID              uint             `json:"language_id"`
	TranslatableID          uint             `json:"translatable_id"`
	TranslatableType        string           `json:"translatable_type"`
	TranslationsStructure   Resources_sub102 `json:"translations_structure"`
	TranslationsStructureID uint             `json:"translations_structure_id"`
	UpToDate                bool             `json:"up_to_date"`
	UpdatedAt               time.Time        `json:"updated_at"`
	UserID                  any              `json:"user_id"`
}

type Upload 

type Upload struct {
	CreatedAt    time.Time `json:"created_at"`
	Description  string    `json:"description"`
	EvaluationID uint      `json:"evaluation_id"`
	ID           uint      `json:"id"`
	Name         string    `json:"name"`
	UpdatedAt    time.Time `json:"updated_at"`
}

type User 

type User struct {
	Achievements    []Achievement   `json:"achievements"`
	Active          bool            `json:"active?"`
	Alumni          bool            `json:"alumni?"`
	AnonymizeDate   string          `json:"anonymize_date"`
	Campus          []UserCampus    `json:"campus"`
	CampusUsers     []CampusUser    `json:"campus_users"`
	CorrectionPoint int             `json:"correction_point"`
	CursusUsers     []CursusUser    `json:"cursus_users"`
	DataErasureDate any             `json:"data_erasure_date"`
	Displayname     string          `json:"displayname"`
	Email           string          `json:"email"`
	ExpertisesUsers []ExpertiseUser `json:"expertises_users"`
	FirstName       string          `json:"first_name"`
	Groups          []any           `json:"groups"`
	ID              uint            `json:"id"`
	Image           Image           `json:"image"`
	Kind            string          `json:"kind"`
	LanguagesUsers  []LanguageUser  `json:"languages_users"`
	LastName        string          `json:"last_name"`
	Location        any             `json:"location"`
	Login           string          `json:"login"`
	Partnerships    []Partnership   `json:"partnerships"`
	Patroned        []Patronage     `json:"patroned"`
	Patroning       []Patronage     `json:"patroning"`
	Phone           any             `json:"phone"`
	PoolMonth       string          `json:"pool_month"`
	PoolYear        string          `json:"pool_year"`
	ProjectsUsers   []ProjectUser   `json:"projects_users"`
	Roles           []Role          `json:"roles"`
	Staff           bool            `json:"staff?"`
	Titles          []Title         `json:"titles"`
	TitlesUsers     []TitleUser     `json:"titles_users"`
	URL             string          `json:"url"`
	UsualFirstName  string          `json:"usual_first_name"`
	UsualFullName   string          `json:"usual_full_name"`
	Wallet          int             `json:"wallet"`
}

type UserCampus 

type UserCampus struct {
	ID          uint     `json:"id"`
	Language    Language `json:"language"`
	Name        string   `json:"name"`
	TimeZone    string   `json:"time_zone"`
	UsersCount  int      `json:"users_count"`
	VogsphereID uint     `json:"vogsphere_id"`
}

type UserCandidature 

type UserCandidature struct {
	BirthCity          string    `json:"birth_city"`
	BirthCountry       string    `json:"birth_country"`
	BirthDate          string    `json:"birth_date"`
	ContactAffiliation any       `json:"contact_affiliation"`
	ContactFirstName   any       `json:"contact_first_name"`
	ContactLastName    any       `json:"contact_last_name"`
	ContactPhone1      any       `json:"contact_phone1"`
	ContactPhone2      any       `json:"contact_phone2"`
	Country            string    `json:"country"`
	CreatedAt          time.Time `json:"created_at"`
	Email              string    `json:"email"`
	Gender             string    `json:"gender"`
	HiddenPhone        any       `json:"hidden_phone"`
	ID                 uint      `json:"id"`
	Language           any       `json:"language"`
	MaxLevelLogic      any       `json:"max_level_logic"`
	MaxLevelMemory     any       `json:"max_level_memory"`
	MeetingDate        any       `json:"meeting_date"`
	OtherInformation   any       `json:"other_information"`
	Phone              any       `json:"phone"`
	PhoneCountryCode   any       `json:"phone_country_code"`
	Pin                any       `json:"pin"`
	PiscineDate        any       `json:"piscine_date"`
	PostalCity         string    `json:"postal_city"`
	PostalComplement   any       `json:"postal_complement"`
	PostalCountry      any       `json:"postal_country"`
	PostalStreet       string    `json:"postal_street"`
	PostalZipCode      any       `json:"postal_zip_code"`
	UpdatedAt          time.Time `json:"updated_at"`
	UserID             uint      `json:"user_id"`
	ZipCode            string    `json:"zip_code"`
}

type Waitlist 

type Waitlist struct {
	ID               int       `json:"id"`
	WaitlistableID   int       `json:"waitlistable_id"`
	WaitlistableType string    `json:"waitlistable_type"`
	CreatedAt        time.Time `json:"created_at"`
	UpdatedAt        time.Time `json:"updated_at"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.