import {z} from 'zod' export type ObservationsCreate = {fields: unknown, observation?: ({uuid?: string | undefined, captive_flag?: boolean | undefined, coordinate_system?: string | undefined, description?: string | undefined, geo_x?: number | undefined, geo_y?: number | undefined, geoprivacy?: string | undefined, latitude?: number | undefined, license?: string | undefined, location_is_exact?: boolean | undefined, longitude?: number | undefined, make_license_default?: boolean | undefined, make_licenses_same?: boolean | undefined, map_scale?: number | undefined, observation_field_values_attributes?: {observation_field_id: number, value: unknown} | undefined, observed_on_string?: string | undefined, owners_identification_from_vision?: boolean | undefined, place_guess?: string | undefined, positional_accuracy?: number | undefined, positioning_device?: string | undefined, positioning_method?: string | undefined, project_id?: number | undefined, prefers_community_taxon?: boolean | undefined, site_id?: number | undefined, species_guess?: string | undefined, tag_list?: string | undefined, taxon_id?: number | undefined, taxon_name?: number | undefined, time_zone?: string | undefined}) | undefined}; export type CreateApiObservationsArgs = {body: ObservationsCreate}; export type CreateApiObservationsOptions = {baseUrl?: string | undefined, userJwtRequired?: string | undefined, fetch?: typeof fetch | undefined}; export const controlledTerm: z.ZodType = z.object({id: z.number().int(), blocking: z.boolean().optional(), is_value: z.boolean().optional(), excepted_taxon_ids: z.array(z.number().int()).optional(), label: z.string().optional(), labels: z.array(z.object({id: z.number().int().optional(), definition: z.string().optional(), label: z.string().optional(), locale: z.string().optional(), valid_within_clade: z.number().int().nullable().optional()})).optional(), multivalued: z.boolean().optional(), ontology_uri: z.string().optional(), taxon_ids: z.array(z.number().int()).optional(), uri: z.string().optional(), uuid: z.string().nullable().optional(), valid_within_clade: z.number().int().nullable().optional(), values: z.array(z.lazy(() => controlledTerm)).optional()}).nullable(); export const site = z.object({id: z.number().int(), icon_url: z.string().optional(), locale: z.string().nullable().optional(), name: z.string().optional(), place_id: z.number().int().nullable().optional(), site_name_short: z.string().nullable().optional(), url: z.string().optional()}).nullable(); export const user = z.object({id: z.number().int(), uuid: z.string().optional(), created_at: z.string().optional(), description: z.string().nullable().optional(), faved_project_ids: z.array(z.number()).optional(), icon: z.string().nullable().optional(), icon_url: z.string().nullable().optional(), identifications_count: z.number().int().optional(), journal_posts_count: z.number().int().optional(), annotated_observations_count: z.number().int().optional(), last_active: z.string().optional(), login: z.string().optional(), monthly_supporter: z.boolean().nullable().optional(), name: z.string().nullable().optional(), observations_count: z.number().int().optional(), orcid: z.string().nullable().optional(), preferences: z.object({prefers_community_taxa: z.boolean().optional(), prefers_observation_fields_by: z.enum(["anyone", "curators", "observer"]).optional(), prefers_project_addition_by: z.enum(["any", "joined", "none"]).optional()}).optional(), roles: z.array(z.string()).optional(), site: site.optional(), site_id: z.number().int().nullable().optional(), spam: z.boolean().optional(), species_count: z.number().int().optional(), suspended: z.boolean().optional(), updated_at: z.string().optional()}).nullable(); export const vote = z.object({id: z.number().int().optional(), created_at: z.string().optional(), user: user.optional(), user_id: z.number().int().optional(), vote_flag: z.boolean().optional(), vote_scope: z.string().nullable().optional()}); export const annotation = z.object({concatenated_attr_val: z.string().optional(), controlled_attribute: controlledTerm.optional(), controlled_attribute_id: z.number().int().optional(), controlled_value: controlledTerm.optional(), controlled_value_id: z.number().int().optional(), user: user.optional(), user_id: z.number().int().optional(), uuid: z.string(), vote_score: z.number().int().optional(), votes: z.array(vote).optional()}); export const dateDetails = z.object({date: z.string(), day: z.number().int(), hour: z.number().int(), month: z.number().int(), week: z.number().int(), year: z.number().int()}).nullable(); export const flag = z.object({id: z.number().int(), comment: z.string().nullable().optional(), created_at: z.string().optional(), created_at_utc: z.string().nullable().optional(), flag: z.string().optional(), flaggable_content: z.string().nullable().optional(), flaggable_id: z.number().int().nullable().optional(), flaggable_type: z.string().nullable().optional(), flaggable_user_id: z.number().int().nullable().optional(), resolved: z.boolean().optional(), resolver_id: z.number().int().nullable().optional(), resolved_at: z.string().nullable().optional(), updated_at: z.string().nullable().optional(), updated_at_utc: z.string().nullable().optional(), user: user.optional(), user_id: z.number().int().optional(), uuid: z.string().nullable().optional()}); export const moderatorAction = z.object({id: z.number().int(), created_at: z.string().optional(), created_at_details: dateDetails.optional(), user: user.optional(), action: z.string().optional(), reason: z.string().optional(), private: z.boolean().optional()}); export const comment = z.object({id: z.number().int().optional(), body: z.string().optional(), created_at: z.string().optional(), created_at_details: dateDetails.optional(), created_at_utc: z.string().optional(), flags: z.array(flag).optional(), hidden: z.boolean().optional(), html: z.string().optional(), moderator_actions: z.array(moderatorAction).optional(), parent_id: z.number().int().nullable().optional(), parent_type: z.string().nullable().optional(), user: user.optional(), user_id: z.number().int().nullable().optional(), updated_at: z.string().optional(), updated_at_details: z.string().optional(), uuid: z.string()}); export const conservationStatus = z.object({id: z.number().int(), authority: z.string().nullable().optional(), description: z.string().nullable().optional(), geoprivacy: z.string().nullable().optional(), iucn: z.number().int().optional(), iucn_status: z.string().optional(), iucn_status_code: z.string().optional(), place: z.object({id: z.number().int().optional(), name: z.string().optional(), display_name: z.string().optional(), ancestry: z.string().nullable().optional()}).nullable().optional(), place_id: z.number().int().nullable().optional(), source_id: z.number().int().nullable().optional(), status: z.string().optional(), status_name: z.string().optional(), taxon_id: z.number().int().optional(), user_id: z.number().int().nullable().optional(), url: z.string().nullable().optional()}).nullable(); export const photo = z.object({id: z.number().int(), attribution: z.string().optional(), attribution_name: z.string().nullable().optional(), flags: z.array(flag).optional(), hidden: z.boolean().optional(), large_url: z.string().nullable().optional(), license_code: z.string().nullable().optional(), medium_url: z.string().nullable().optional(), moderator_actions: z.array(moderatorAction).optional(), native_page_url: z.string().nullable().optional(), native_photo_id: z.string().nullable().optional(), original_dimensions: z.object({height: z.number().int().nullable().optional(), width: z.number().int().nullable().optional()}).nullable().optional(), original_url: z.string().nullable().optional(), small_url: z.string().nullable().optional(), square_url: z.string().nullable().optional(), type: z.string().optional(), url: z.string().nullable().optional(), original_filename: z.string().nullable().optional()}).nullable(); export const list = z.object({id: z.number().int(), title: z.string().nullable().optional()}).nullable(); export const polygonGeoJson = z.object({type: z.string(), coordinates: z.union([z.array(z.array(z.array(z.array(z.number())))), z.array(z.array(z.array(z.number())))])}).nullable(); export const pointGeoJson = z.object({coordinates: z.array(z.number()), type: z.string()}).nullable(); export const place = z.object({id: z.number().int(), admin_level: z.number().int().nullable().optional(), ancestor_place_ids: z.array(z.number().int()).nullable().optional(), bbox_area: z.number().nullable().optional(), bounding_box_geojson: polygonGeoJson.optional(), display_name: z.string().nullable().optional(), display_name_autocomplete: z.string().nullable().optional(), geometry_geojson: polygonGeoJson.optional(), location: z.string().nullable().optional(), matched_term: z.string().nullable().optional(), name: z.string().optional(), observations_count: z.number().int().optional(), place_type: z.number().int().nullable().optional(), point_geojson: pointGeoJson.optional(), slug: z.string().nullable().optional(), universal_search_rank: z.number().int().nullable().optional(), user: user.optional(), uuid: z.string().optional(), without_check_list: z.boolean().nullable().optional()}).nullable(); export const taxon: z.ZodType = z.object({id: z.number().int(), uuid: z.string().optional(), ancestors: z.array(z.lazy(() => taxon)).optional(), ancestor_ids: z.array(z.number().int()).optional(), ancestry: z.string().nullable().optional(), atlas_id: z.number().int().nullable().optional(), children: z.array(z.lazy(() => taxon)).optional(), complete_rank: z.string().optional(), complete_species_count: z.number().int().nullable().optional(), conservation_status: conservationStatus.optional(), conservation_statuses: z.array(conservationStatus).optional(), created_at: z.string().optional(), current_synonymous_taxon_ids: z.array(z.number().int()).nullable().optional(), default_photo: photo.optional(), endemic: z.boolean().optional(), english_common_name: z.string().optional(), establishment_means: z.object({establishment_means: z.string().optional(), id: z.number().int().optional(), place: z.object({id: z.number().int().optional(), name: z.string().optional(), display_name: z.string().optional(), ancestry: z.string().nullable().optional()}).optional()}).optional(), preferred_establishment_means: z.string().optional(), extinct: z.boolean().optional(), provisional: z.boolean().optional(), flag_counts: z.object({resolved: z.number().int().optional(), unresolved: z.number().int().optional()}).optional(), iconic_taxon_id: z.number().int().nullable().optional(), iconic_taxon_name: z.string().nullable().optional(), introduced: z.boolean().optional(), is_active: z.boolean().optional(), listed_taxa: z.array(z.object({id: z.number().int().optional(), establishment_means: z.string().optional(), list: list.optional(), taxon: z.lazy(() => taxon.optional()), taxon_id: z.number().int().optional(), place: place.optional()})).optional(), listed_taxa_count: z.number().int().optional(), matched_term: z.string().optional(), min_species_ancestry: z.string().optional(), min_species_taxon_id: z.number().int().optional(), name: z.string().optional(), native: z.boolean().optional(), observations_count: z.number().int().optional(), parent_id: z.number().int().nullable().optional(), photos_locked: z.boolean().optional(), preferred_common_name: z.string().nullable().optional(), preferred_common_names: z.array(z.unknown()).nullable().optional(), rank: z.string().optional(), rank_level: z.number().optional(), representative_photo: photo.optional(), statuses: z.array(z.unknown()).optional(), taxon_changes_count: z.number().int().optional(), taxon_photos: z.array(z.object({taxon: z.lazy(() => taxon.optional()), taxon_id: z.number().int().optional(), photo: photo.optional()})).optional(), taxon_schemes_count: z.number().int().optional(), threatened: z.boolean().optional(), universal_search_rank: z.number().int().optional(), vision: z.boolean().optional(), wikipedia_summary: z.string().nullable().optional(), wikipedia_url: z.string().nullable().optional()}).nullable(); export const identification = z.object({id: z.number().int(), body: z.string().nullable().optional(), category: z.string().nullable().optional(), created_at: z.string().optional(), created_at_details: dateDetails.optional(), current: z.boolean().optional(), disagreement: z.boolean().nullable().optional(), exemplar_identification: z.object({id: z.number().int(), nominated_by_user: z.object({id: z.number().int().optional(), login: z.string().optional(), name: z.string().nullable().optional(), icon: z.string().nullable().optional()}).nullable().optional(), nominated_at: z.string().nullable().optional(), votes: z.array(vote).optional(), cached_votes_total: z.number().int().optional()}).nullable().optional(), flags: z.array(flag).optional(), hidden: z.boolean().optional(), moderator_actions: z.array(moderatorAction).optional(), observation_id: z.number().int().optional(), own_observation: z.boolean().optional(), previous_observation_taxon_id: z.number().int().nullable().optional(), previous_observation_taxon: taxon.optional(), spam: z.boolean().optional(), taxon: taxon.optional(), taxon_change: z.object({id: z.number().int(), type: z.string()}).nullable().optional(), taxon_change_id: z.number().int().nullable().optional(), taxon_change_type: z.string().nullable().optional(), taxon_id: z.number().int().optional(), updated_at: z.string().optional(), user: user.optional(), user_id: z.number().int().optional(), uuid: z.string().optional(), vision: z.boolean().optional()}); export const observationField = z.object({id: z.number().int(), allowed_values: z.string().nullable().optional(), datatype: z.string().optional(), description: z.string().nullable().optional(), description_autocomplete: z.string().nullable().optional(), name: z.string().optional(), name_autocomplete: z.string().optional(), users_count: z.number().int().nullable().optional(), uuid: z.string().optional(), values_count: z.number().int().nullable().optional()}); export const project: z.ZodType = z.object({id: z.number().int(), admins: z.array(z.object({id: z.number().int().optional(), project_id: z.number().int().optional(), role: z.string().optional(), user: user.optional(), user_id: z.number().int().optional()})).optional(), banner_color: z.string().nullable().optional(), created_at: z.string().optional(), delegated_project_id: z.number().int().nullable().optional(), description: z.string().nullable().optional(), flags: z.array(flag).optional(), header_image_contain: z.boolean().optional(), header_image_file_name: z.string().nullable().optional(), header_image_url: z.string().nullable().optional(), hide_leaderboard: z.boolean().optional(), hide_title: z.boolean().optional(), hide_umbrella_map_flags: z.boolean().optional(), icon: z.string().nullable().optional(), icon_file_name: z.string().nullable().optional(), is_delegated_umbrella: z.boolean().nullable().optional(), is_umbrella: z.boolean().optional(), latitude: z.string().optional(), location: z.string().nullable().optional(), longitude: z.string().optional(), membership_model: z.string().nullable().optional(), observation_requirements_updated_at: z.string().nullable().optional(), place_id: z.number().int().nullable().optional(), prefers_user_trust: z.boolean().nullable().optional(), project_observation_fields: z.array(z.object({id: z.number().int(), observation_field: observationField.optional(), position: z.number().int().optional(), required: z.boolean().nullable().optional()})).optional(), project_observation_rules: z.array(z.object({id: z.number().int(), operand_id: z.number().int().nullable().optional(), operand_type: z.string().nullable().optional(), operator: z.string().optional(), place: place.optional(), project: z.lazy(() => project.optional()), taxon: taxon.optional(), user: user.optional()})).optional(), project_type: z.string().nullable().optional(), rule_preferences: z.array(z.object({field: z.string().optional(), value: z.unknown()})).optional(), search_parameters: z.array(z.object({field: z.string().optional(), value: z.unknown(), value_bool: z.boolean().optional(), value_date: z.array(z.string()).optional(), value_keyword: z.unknown(), value_number: z.union([z.number(), z.array(z.number())]).optional()})).optional(), site_features: z.array(z.object({noteworthy: z.boolean().optional(), site_id: z.number().int().optional(), featured_at: z.string().optional()})).nullable().optional(), slug: z.string().optional(), terms: z.string().nullable().optional(), title: z.string().optional(), updated_at: z.string().optional(), user: user.optional(), user_id: z.number().int().optional(), user_ids: z.array(z.number().int()).optional(), umbrella_project_list_sort: z.string().nullable().optional()}).nullable(); export const observationPhoto = z.object({id: z.number().int(), photo: photo.optional(), position: z.number().int().nullable().optional(), uuid: z.string().optional()}); export const sound = z.object({attribution: z.string().optional(), file_content_type: z.string().nullable().optional(), file_url: z.string().nullable().optional(), flags: z.array(flag).optional(), hidden: z.boolean().optional(), id: z.number().int(), license_code: z.string().nullable().optional(), moderator_actions: z.array(moderatorAction).optional(), native_sound_id: z.string().nullable().optional(), original_filename: z.string().nullable().optional()}).nullable(); export const observationSound = z.object({id: z.number().int(), sound: sound.optional(), position: z.number().int().optional(), uuid: z.string().optional()}); export const observationFieldValue = z.object({id: z.number().int().optional(), datatype: z.string().optional(), field_id: z.number().int().optional(), name: z.string().optional(), name_ci: z.string().optional(), observation_field: observationField.optional(), taxon: taxon.optional(), taxon_id: z.string().optional(), user: user.optional(), user_id: z.number().int().optional(), uuid: z.string().optional(), value: z.string().optional(), value_ci: z.string().optional()}); export const projectUser = z.object({id: z.number().int(), observations_count: z.number().int().optional(), prefers_curator_coordinate_access_for: z.string().optional(), project_id: z.number().int().optional(), role: z.string().nullable().optional(), taxa_count: z.number().int().optional(), user_id: z.number().int().optional(), created_at: z.string().optional(), created_at_utc: z.string().optional(), updated_at: z.string().optional(), updated_at_utc: z.string().optional()}); export const projectObservation = z.object({id: z.number().int(), current_user_is_member: z.boolean().optional(), preferences: z.object({allows_curator_coordinate_access: z.boolean().optional()}).optional(), project: project.optional(), project_id: z.number().int().optional(), project_user: projectUser.optional(), user: user.optional(), user_id: z.number().int().nullable().optional(), uuid: z.string()}); export const qualityMetric = z.object({id: z.number().int(), agree: z.boolean().optional(), metric: z.string().optional(), user: user.optional(), user_id: z.number().int().nullable().optional()}); export const observation = z.object({id: z.number().int().nullable().optional(), annotations: z.array(annotation).optional(), application: z.object({id: z.number().int(), icon: z.string().nullable().optional(), name: z.string().optional(), url: z.string().optional()}).optional(), cached_votes_total: z.number().int().optional(), captive: z.boolean().optional(), comments: z.array(comment).optional(), comments_count: z.number().int().optional(), community_taxon: taxon.optional(), community_taxon_id: z.number().int().nullable().optional(), context_geoprivacy: z.string().nullable().optional(), context_taxon_geoprivacy: z.string().nullable().optional(), context_user_geoprivacy: z.string().nullable().optional(), created_at: z.string().optional(), created_at_details: dateDetails.optional(), created_time_zone: z.string().optional(), description: z.string().nullable().optional(), faves: z.array(vote).optional(), faves_count: z.number().int().optional(), flags: z.array(flag).optional(), geojson: pointGeoJson.optional(), geoprivacy: z.string().nullable().optional(), id_please: z.boolean().optional(), ident_taxon_ids: z.array(z.number().int()).optional(), identifications: z.array(identification).optional(), identifications_count: z.number().int().optional(), identifications_most_agree: z.boolean().optional(), identifications_most_disagree: z.boolean().optional(), identifications_some_agree: z.boolean().optional(), license_code: z.string().nullable().optional(), location: z.string().nullable().optional(), map_scale: z.number().int().nullable().optional(), mappable: z.boolean().optional(), non_owner_ids: z.array(identification).optional(), non_traditional_projects: z.array(z.object({current_user_is_member: z.boolean().optional(), project: project.optional(), projectUser: z.object({role: z.string().optional(), prefers_curator_coordinate_access_for: z.string().optional()}).optional()})).optional(), num_identification_agreements: z.number().int().optional(), num_identification_disagreements: z.number().int().optional(), oauth_application_id: z.number().int().nullable().optional(), obscured: z.boolean().optional(), observation_photos: z.array(observationPhoto).optional(), observation_sounds: z.array(observationSound).optional(), observed_on: z.string().nullable().optional(), observed_on_details: dateDetails.optional(), observed_on_string: z.string().nullable().optional(), observed_time_zone: z.string().nullable().optional(), ofvs: z.array(observationFieldValue).optional(), out_of_range: z.boolean().nullable().optional(), outlinks: z.array(z.object({source: z.string().optional(), url: z.string().optional()})).optional(), owners_identification_from_vision: z.boolean().nullable().optional(), photos: z.array(photo).optional(), place_guess: z.string().nullable().optional(), place_ids: z.array(z.number().int()).optional(), positional_accuracy: z.number().int().nullable().optional(), preferences: z.object({auto_obscuration: z.boolean().optional(), prefers_community_taxon: z.boolean().nullable().optional()}).optional(), private_geojson: pointGeoJson.optional(), private_location: z.string().nullable().optional(), private_place_guess: z.string().nullable().optional(), project_ids: z.array(z.number().int()).optional(), project_ids_with_curator_id: z.array(z.number().int()).optional(), project_ids_without_curator_id: z.array(z.number().int()).optional(), project_observations: z.array(projectObservation).optional(), public_positional_accuracy: z.number().int().nullable().optional(), quality_grade: z.string().optional(), quality_metrics: z.array(qualityMetric).optional(), reviewed_by: z.array(z.number().int()).optional(), site_id: z.number().int().nullable().optional(), sounds: z.array(sound).optional(), spam: z.boolean().optional(), species_guess: z.string().nullable().optional(), tags: z.array(z.string()).optional(), taxon: taxon.optional(), taxon_geoprivacy: z.string().nullable().optional(), time_observed_at: z.string().nullable().optional(), time_zone_offset: z.string().optional(), updated_at: z.string().optional(), uri: z.string().optional(), user: user.optional(), uuid: z.string(), viewer_trusted_by_observer: z.boolean().nullable().optional(), votes: z.array(vote).optional()}); export const resultsObservations = z.object({total_results: z.number().int(), total_bounds: z.object({swlat: z.number().optional(), swlng: z.number().optional(), nelat: z.number().optional(), nelng: z.number().optional()}).optional(), page: z.number().int(), per_page: z.number().int(), results: z.array(observation)}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Create observations. * * POST /observations */ export const createApiObservations = async (args: CreateApiObservationsArgs, options?: CreateApiObservationsOptions) => { const {baseUrl = "https://api.inaturalist.org/v2", fetch: fetchFn = fetch, userJwtRequired} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") if (userJwtRequired !== undefined) headers.set("Authorization", userJwtRequired) const url = `${baseUrl.replace(/\/+$/, '')}/observations${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "POST", headers, body: JSON.stringify(args.body)}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(resultsObservations, await res.json()) };