❤
npm
Sign UpSign In

@datafire/uebermaps

6.0.0 • Public • Published

@datafire/uebermaps

Client library for uebermaps API endpoints

Installation and Usage

npm install --save @datafire/uebermaps
let uebermaps = require('@datafire/uebermaps').create();

.then(data => {
  console.log(data);
});

Description

Enable people to store spots on public and private maps

Actions

account.patch

Update account. Wrap map parameters in [user].

uebermaps.account.patch({}, context)

Input

Output

attachments.id.delete

Delete attachment.

uebermaps.attachments.id.delete({
  "id": 0
}, context)

Input

  • input object
    • id required integer: Attachment id

Output

authentication.post

Sign in user. Wrap authentication parameters in [user].

uebermaps.authentication.post({
  "user": null
}, context)

Input

Output

collaborator_invitations.get

List your collaborator invitations.

uebermaps.collaborator_invitations.get(null, context)

Input

This action has no parameters

Output

collaborator_invitations.post

Invite user to collaborate on map.

uebermaps.collaborator_invitations.post({}, context)

Input

Output

collaborator_invitations.id.delete

Delete collaborator invitation.

uebermaps.collaborator_invitations.id.delete({
  "id": 0
}, context)

Input

  • input object
    • id required integer: Collaborator invitation id

Output

collaborator_invitations.id.get

Show collaborator invitation

uebermaps.collaborator_invitations.id.get({
  "id": 0
}, context)

Input

  • input object
    • id required integer: Collaborator invitation id

Output

collaborator_invitations.id.patch

Accept collaborator invitation.

uebermaps.collaborator_invitations.id.patch({
  "id": 0
}, context)

Input

  • input object
    • id required integer: Collaborator invitation id

Output

comments.id.delete

Delete comment.

uebermaps.comments.id.delete({
  "id": 0
}, context)

Input

  • input object
    • id required integer: Comment id

Output

comments.id.patch

Update comment. Wrap comment parameters in [comment].

uebermaps.comments.id.patch({
  "id": 0
}, context)

Input

Output

events.get

List your own events.

uebermaps.events.get({}, context)

Input

  • input object
    • timeframe_start string: Begin of time range of event (ISO 8601 date format).
    • timeframe_end string: End of time range of event (ISO 8601 date format).
    • bounds string: To refine your event index request to contain only events within a geographical box pass the followng bounds parameters. F. e. to get events within 'Hamburg, St. Pauli': bounds[sw_lat]=53.54831449741324 bounds[sw_lon]=9.943227767944336 bounds[ne_lat]=53.5571103674878 bounds[ne_lon]=9.9776029586792

Output

  • output array

events.id.delete

Delete event.

uebermaps.events.id.delete({
  "id": 0
}, context)

Input

  • input object
    • id required integer: Event id

Output

events.id.get

Get basic information about an event

uebermaps.events.id.get({
  "id": 0
}, context)

Input

  • input object
    • id required integer: Id of event

Output

events.id.patch

Update event. Wrap event parameters in [event].

uebermaps.events.id.patch({
  "id": 0
}, context)

Input

Output

maps.get

List your own maps.

uebermaps.maps.get(null, context)

Input

This action has no parameters

Output

  • output array

maps.post

Create map. Wrap map parameters in [map]. To add a map header picture pass a base64 encoded string to [map][picture].

uebermaps.maps.post({}, context)

Input

Output

maps.search.get

Search maps

uebermaps.maps.search.get({}, context)

Input

  • input object
    • q string: Query
    • d integer: Distance. Diameter of search radius in meter (default: 2000 meter)
    • lat number: Latitude for search radius (default distance: 2000 meter)
    • lon number: Longitude for search radius (default distance: 2000 meter)

Output

maps.id.delete

Delete map.

uebermaps.maps.id.delete({
  "id": 0
}, context)

Input

  • input object
    • id required integer: map id

Output

maps.id.get

Get basic information about a map

uebermaps.maps.id.get({
  "id": 0
}, context)

Input

  • input object
    • id required integer: Id of map

Output

maps.id.patch

Update map. Wrap map parameters in [map]. To update the map header picture pass a base64 encoded string to [map][picture].

uebermaps.maps.id.patch({
  "id": 0
}, context)

Input

  • input object

Output

maps.id.attachments.get

List attachments for a given map.

uebermaps.maps.id.attachments.get({
  "id": 0
}, context)

Input

  • input object
    • id required integer: Map id

Output

maps.id.attachments.post

Upload map attachment. Wrap attachment parameters in [attachment]

uebermaps.maps.id.attachments.post({
  "id": 0,
  "image": ""
}, context)

Input

  • input object
    • id required integer: Map id
    • image required string

Output

maps.id.collaborators.get

List collaborators of a map.

uebermaps.maps.id.collaborators.get({
  "id": 0
}, context)

Input

  • input object
    • id required integer: Map id

Output

maps.id.collaborators.user_id.delete

Delete collaboration.

uebermaps.maps.id.collaborators.user_id.delete({
  "id": 0,
  "user_id": 0
}, context)

Input

  • input object
    • id required integer: map id
    • user_id required integer: user id

Output

maps.id.collaborators.user_id.patch

Update collaborator. Wrap collaborator parameters in [collaborator]

uebermaps.maps.id.collaborators.user_id.patch({
  "id": 0,
  "user_id": 0
}, context)

Input

  • input object

Output

maps.id.comments.get

List comments for a given map.

uebermaps.maps.id.comments.get({
  "id": 0
}, context)

Input

  • input object
    • id required integer: Id of map

Output

maps.id.comments.post

Create map comment. Wrap comment parameters in [comment].

uebermaps.maps.id.comments.post({
  "id": 0
}, context)

Input

Output

maps.id.respots.get

List respots of a map.

uebermaps.maps.id.respots.get({
  "id": 0
}, context)

Input

  • input object
    • id required integer: Map Id

Output

maps.id.spots.get

List spots for a given map.

uebermaps.maps.id.spots.get({
  "id": 0
}, context)

Input

  • input object
    • id required integer: Id of map
    • order string (values: created_at_asc, created_at_desc, updated_at_asc, updated_at_desc, title_asc, title_desc): Order of spots

Output

  • output array

maps.id.spots.post

Create spot. Wrap parameters in [spot]. To add a spot picture pass a base64 encoded string to [spot][picture].

uebermaps.maps.id.spots.post({
  "id": 0,
  "spot": null
}, context)

Input

  • input object

Output

maps.id.subscriptions.delete

Unsubscribe from map.

uebermaps.maps.id.subscriptions.delete({
  "id": 0
}, context)

Input

  • input object
    • id required integer: map id

Output

maps.id.subscriptions.get

List subscriptions for a given map.

uebermaps.maps.id.subscriptions.get({
  "id": 0
}, context)

Input

  • input object
    • id required integer: Id of map

Output

maps.map_id.spots.id.get

Get basic information about a spot

uebermaps.maps.map_id.spots.id.get({
  "id": 0,
  "map_id": 0
}, context)

Input

  • input object
    • id required integer: Id of spot
    • map_id required integer: Id of map

Output

maps.map_id.spots.spot_id.respot.delete

Delete respot from map by spot id.

uebermaps.maps.map_id.spots.spot_id.respot.delete({
  "map_id": 0,
  "spot_id": 0
}, context)

Input

  • input object
    • map_id required integer: Map Id
    • spot_id required integer: Spot Id

Output

respot_maps.get

List maps that user can respot to.

uebermaps.respot_maps.get(null, context)

Input

This action has no parameters

Output

  • output array

respots.id.delete

Delete respot.

uebermaps.respots.id.delete({
  "id": 0
}, context)

Input

  • input object
    • id required integer: Respot Id

Output

respots.id.get

Get basic information about a respot

uebermaps.respots.id.get({
  "id": 0
}, context)

Input

  • input object
    • id required integer: Id of respot

Output

share.map.id.get

Get secret access token of an uebermap with access set to 'Secret link'. Pass the 'token' on every request you make to access this uebermap and its resources. F.e. token=1-x_gqu7eLBe3uKoAGAGXy

uebermaps.share.map.id.get({
  "id": 0
}, context)

Input

  • input object
    • id required integer: Id of map

Output

spots.get

List your own spots.

uebermaps.spots.get({}, context)

Input

  • input object
    • order string (values: created_at_asc, created_at_desc, updated_at_asc, updated_at_desc, title_asc, title_desc): Order of spots

Output

  • output array

spots.search.get

Search spots

uebermaps.spots.search.get({}, context)

Input

  • input object
    • q string: Query
    • d integer: Distance. Diameter of search radius in meter (default: 2000 meter)
    • lat number: Latitude for search radius (2 km)
    • lon number: Longitude for search radius (2 km)

Output

spots.id.delete

Delete spot.

uebermaps.spots.id.delete({
  "id": 0
}, context)

Input

  • input object
    • id required integer: spot id

Output

spots.id.patch

Update spot. Wrap parameters in [spot]. To update the spot picture pass a base64 encoded string to [spot][picture].

uebermaps.spots.id.patch({
  "id": 0
}, context)

Input

  • input object

Output

spots.id.attachments.get

List attachments for a given spot.

uebermaps.spots.id.attachments.get({
  "id": 0
}, context)

Input

  • input object
    • id required integer: Spot id

Output

spots.id.attachments.post

Upload spot attachment. Wrap attachment parameters in [attachment]

uebermaps.spots.id.attachments.post({
  "id": 0,
  "image": ""
}, context)

Input

  • input object
    • id required integer: Spot id
    • image required string

Output

spots.id.comments.get

List comments for a given spot.

uebermaps.spots.id.comments.get({
  "id": 0
}, context)

Input

  • input object
    • id required integer: Id of spot

Output

spots.id.comments.post

Create spot comment. Wrap comment parameters in [comment].

uebermaps.spots.id.comments.post({
  "id": 0
}, context)

Input

Output

spots.id.events.get

List maps for a given spot.

uebermaps.spots.id.events.get({
  "id": 0
}, context)

Input

  • input object
    • id required integer: Id of spot
    • timeframe_start string: Begin of time range of event (ISO 8601 date format).
    • timeframe_end string: End of time range of event (ISO 8601 date format).
    • bounds string: To refine your event index request to contain only events within a geographical box pass the followng bounds parameters. F. e. to get events within 'Hamburg, St. Pauli': bounds[sw_lat]=53.54831449741324 bounds[sw_lon]=9.943227767944336 bounds[ne_lat]=53.5571103674878 bounds[ne_lon]=9.9776029586792

Output

  • output array

spots.id.events.post

Create event. Wrap map parameters in [event].

uebermaps.spots.id.events.post({
  "id": 0
}, context)

Input

Output

spots.id.respots.post

Respot a spot onto a map.

uebermaps.spots.id.respots.post({
  "id": 0,
  "map_id": 0
}, context)

Input

  • input object
    • id required integer: Spot Id
    • map_id required number

Output

subscriptions.get

List subscriptions.

uebermaps.subscriptions.get({}, context)

Input

  • input object
    • user_id integer: Id of user
    • map_id integer: Id of map

Output

subscriptions.post

Create map subscription.

uebermaps.subscriptions.post({
  "map_id": 0
}, context)

Input

  • input object
    • map_id required number

Output

trends.latest.get

List latest maps.

uebermaps.trends.latest.get(null, context)

Input

This action has no parameters

Output

  • output array

trends.recommended.get

List recommended maps.

uebermaps.trends.recommended.get(null, context)

Input

This action has no parameters

Output

  • output array

users.search.get

Search users

uebermaps.users.search.get({}, context)

Input

  • input object
    • q string: Query

Output

users.id.get

Get profile a user

uebermaps.users.id.get({
  "id": 0
}, context)

Input

  • input object
    • id required integer: Id of user

Output

users.user_id.maps.get

List maps for a given user.

uebermaps.users.user_id.maps.get({
  "user_id": 0
}, context)

Input

  • input object
    • user_id required integer: Id of user

Output

  • output array

Definitions

Attachment

  • Attachment object
    • attachable_id integer
    • attachable_type string
    • created_at string
    • description string
    • file_url string
    • id integer
    • map_id integer
    • sizes object
    • spot Spot
    • status string (values: approved, unapproved)
    • user User

Collaborator

  • Collaborator object
    • created_at string
    • group string (values: admin, editor)
    • id integer
    • is_admin boolean
    • map Map
    • map_id integer
    • updated_at string
    • user User
    • user_id integer

CollaboratorEditable

  • CollaboratorEditable object
    • group string (values: admin, editor)

CollaboratorInvitation

  • CollaboratorInvitation object
    • accepted boolean
    • created_at string
    • email string
    • group string (values: admin, editor)
    • id integer
    • invited_by_user User
    • map Map
    • sent boolean
    • updated_at string
    • user User

CollaboratorInvitationCreate

  • CollaboratorInvitationCreate object
    • emails string
    • is_admin boolean
    • map_id integer
    • user_ids string

Comment

  • Comment object
    • body string
    • created_at string
    • id integer
    • status string (values: approved, unapproved)
    • updated_at string
    • user User

CommentEditable

  • CommentEditable object
    • body string

Event

  • Event object
    • counts EventCounts
    • created_at string
    • description string
    • ends_at string
    • id integer
    • lat number
    • lon number
    • owner_id integer
    • picture_url string
    • spot Spot
    • starts_at string
    • time_zone string
    • title string
    • updated_at string
    • user User

EventCounts

  • EventCounts object
    • attachments integer
    • comments integer

EventEditable

  • EventEditable object
    • description string
    • ends_at string
    • lat number
    • lon number
    • picture string
    • starts_at string
    • time_zone string
    • title string
    • user_id integer

Map

  • Map object
    • counts MapCounts
    • created_at string
    • description string
    • id integer
    • map_settings MapSettings
    • owner_id integer
    • picture_url string
    • title string
    • updated_at string
    • visibility string (values: public, link, private)

MapCounts

  • MapCounts object
    • attachments integer
    • comments integer
    • impressions integer
    • respots integer
    • spots integer
    • subscriptions integer

MapEditable

  • MapEditable object
    • description string
    • map_settings MapSettings
    • picture string
    • title string
    • visibility string (values: public, link, private)

MapRelation

  • MapRelation object
    • access string
    • access_group string (values: visitor, editor, admin)
    • subscribed boolean

MapSettings

  • MapSettings object
    • editor_access string
    • respotting_to_this_map boolean
    • visitor_access string

MapWithAuthToken

  • MapWithAuthToken object
    • counts MapCounts
    • created_at string
    • description string
    • id integer
    • owner_id integer
    • picture_url string
    • title string
    • token string
    • updated_at string
    • visibility string (values: public, link, private)

MapWithRelation

  • MapWithRelation object
    • counts MapCounts
    • created_at string
    • description string
    • id integer
    • map_settings MapSettings
    • owner_id integer
    • picture_url string
    • relation MapRelation
    • title string
    • updated_at string
    • visibility string (values: public, link, private)

Respot

  • Respot object
    • created_at string
    • id integer
    • map Map
    • map_id integer
    • spot Spot
    • updated_at string
    • user User

Spot

  • Spot object
    • counts SpotCounts
    • created_at string
    • description string
    • id integer
    • lat number
    • lon number
    • map_id integer
    • picture_url string
    • status string (values: approved, unapproved)
    • time_zone string
    • title string
    • updated_at string
    • user User

SpotCounts

  • SpotCounts object
    • attachments integer
    • comments integer
    • respot integer

SpotEditable

  • SpotEditable object
    • description string
    • lat number
    • lon number
    • picture string
    • time_zone string
    • title string

Subscription

  • Subscription object
    • created_at string
    • id integer
    • map Map
    • updated_at string
    • user User
    • user_id integer

User

  • User object
    • about string
    • counts object
      • maps integer
    • header_picture string
    • id integer
    • location string
    • name string
    • picture_url string
    • screen_name string
    • url string

UserAuthentication

  • UserAuthentication object
    • email string
    • password string

UserEditable

  • UserEditable object
    • about string
    • header string
    • language string
    • location string
    • name string
    • picture string
    • screen_name string
    • time_zone string
    • url string

UserFullProfile

  • UserFullProfile object
    • auth_token string
    • language string
    • time_zone string
    • about string
    • counts object
      • maps integer
    • header_picture string
    • id integer
    • location string
    • name string
    • picture_url string
    • screen_name string
    • url string

Readme

Keywords

none

Package Sidebar

Install

npm i @datafire/uebermaps

Repository

github.com/DataFire/integrations

Homepage

github.com/DataFire/integrations#readme

Weekly Downloads

2

Version

6.0.0

License

MIT

Unpacked Size

91 kB

Total Files

4

Last publish

Collaborators

  • datafire
Try on RunKit
Report malware