-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdataobservationgeorecent.go
116 lines (102 loc) · 5.17 KB
/
dataobservationgeorecent.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
package phoebe
import (
"context"
"net/http"
"net/url"
"github.com/phoebe-bird/phoebe-go/internal/apiquery"
"github.com/phoebe-bird/phoebe-go/internal/param"
"github.com/phoebe-bird/phoebe-go/internal/requestconfig"
"github.com/phoebe-bird/phoebe-go/option"
)
// DataObservationGeoRecentService contains methods and other services that help
// with interacting with the phoebe API.
//
// Note, unlike clients, this service does not read variables from the environment
// automatically. You should not instantiate this service directly, and instead use
// the [NewDataObservationGeoRecentService] method instead.
type DataObservationGeoRecentService struct {
Options []option.RequestOption
Species *DataObservationGeoRecentSpecieService
Notable *DataObservationGeoRecentNotableService
}
// NewDataObservationGeoRecentService generates a new service that applies the
// given options to each request. These options are applied after the parent
// client's options (if there is one), and before any request-specific options.
func NewDataObservationGeoRecentService(opts ...option.RequestOption) (r *DataObservationGeoRecentService) {
r = &DataObservationGeoRecentService{}
r.Options = opts
r.Species = NewDataObservationGeoRecentSpecieService(opts...)
r.Notable = NewDataObservationGeoRecentNotableService(opts...)
return
}
// Get the list of recent observations (up to 30 days ago) of birds seen at
// locations within a radius of up to 50 kilometers, from a given set of
// coordinates. Results include only the most recent observation for each species
// in the region specified.
func (r *DataObservationGeoRecentService) List(ctx context.Context, query DataObservationGeoRecentListParams, opts ...option.RequestOption) (res *[]Observation, err error) {
opts = append(r.Options[:], opts...)
path := "data/obs/geo/recent"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, query, &res, opts...)
return
}
type DataObservationGeoRecentListParams struct {
Lat param.Field[float64] `query:"lat,required"`
Lng param.Field[float64] `query:"lng,required"`
// The number of days back to fetch observations.
Back param.Field[int64] `query:"back"`
// Only fetch observations from these taxonomic categories
Cat param.Field[DataObservationGeoRecentListParamsCat] `query:"cat"`
// The search radius from the given position, in kilometers.
Dist param.Field[int64] `query:"dist"`
// Only fetch observations from hotspots
Hotspot param.Field[bool] `query:"hotspot"`
// Include observations which have not yet been reviewed.
IncludeProvisional param.Field[bool] `query:"includeProvisional"`
// Only fetch this number of observations
MaxResults param.Field[int64] `query:"maxResults"`
// Sort observations by taxonomy or by date, most recent first.
Sort param.Field[DataObservationGeoRecentListParamsSort] `query:"sort"`
// Use this language for species common names
SppLocale param.Field[string] `query:"sppLocale"`
}
// URLQuery serializes [DataObservationGeoRecentListParams]'s query parameters as
// `url.Values`.
func (r DataObservationGeoRecentListParams) URLQuery() (v url.Values) {
return apiquery.MarshalWithSettings(r, apiquery.QuerySettings{
ArrayFormat: apiquery.ArrayQueryFormatComma,
NestedFormat: apiquery.NestedQueryFormatBrackets,
})
}
// Only fetch observations from these taxonomic categories
type DataObservationGeoRecentListParamsCat string
const (
DataObservationGeoRecentListParamsCatSpecies DataObservationGeoRecentListParamsCat = "species"
DataObservationGeoRecentListParamsCatSlash DataObservationGeoRecentListParamsCat = "slash"
DataObservationGeoRecentListParamsCatIssf DataObservationGeoRecentListParamsCat = "issf"
DataObservationGeoRecentListParamsCatSpuh DataObservationGeoRecentListParamsCat = "spuh"
DataObservationGeoRecentListParamsCatHybrid DataObservationGeoRecentListParamsCat = "hybrid"
DataObservationGeoRecentListParamsCatDomestic DataObservationGeoRecentListParamsCat = "domestic"
DataObservationGeoRecentListParamsCatForm DataObservationGeoRecentListParamsCat = "form"
DataObservationGeoRecentListParamsCatIntergrade DataObservationGeoRecentListParamsCat = "intergrade"
)
func (r DataObservationGeoRecentListParamsCat) IsKnown() bool {
switch r {
case DataObservationGeoRecentListParamsCatSpecies, DataObservationGeoRecentListParamsCatSlash, DataObservationGeoRecentListParamsCatIssf, DataObservationGeoRecentListParamsCatSpuh, DataObservationGeoRecentListParamsCatHybrid, DataObservationGeoRecentListParamsCatDomestic, DataObservationGeoRecentListParamsCatForm, DataObservationGeoRecentListParamsCatIntergrade:
return true
}
return false
}
// Sort observations by taxonomy or by date, most recent first.
type DataObservationGeoRecentListParamsSort string
const (
DataObservationGeoRecentListParamsSortDate DataObservationGeoRecentListParamsSort = "date"
DataObservationGeoRecentListParamsSortSpecies DataObservationGeoRecentListParamsSort = "species"
)
func (r DataObservationGeoRecentListParamsSort) IsKnown() bool {
switch r {
case DataObservationGeoRecentListParamsSortDate, DataObservationGeoRecentListParamsSortSpecies:
return true
}
return false
}