https://github.com/borud/geoclient-go
Temporary repository containing geoclient-go library
https://github.com/borud/geoclient-go
Last synced: about 1 month ago
JSON representation
Temporary repository containing geoclient-go library
- Host: GitHub
- URL: https://github.com/borud/geoclient-go
- Owner: borud
- Created: 2020-08-19T13:19:53.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-08-19T13:21:48.000Z (almost 6 years ago)
- Last Synced: 2025-02-24T10:44:02.043Z (over 1 year ago)
- Language: Go
- Size: 46.9 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Go API client for geoclient
The Geo API provides access to the different features of the Telenor Geo server, including capabilities such as pub/sub, geofencing and storage of tracking data.
## Overview
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.
- API version: v0.1
- Package version: 0.1.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen
## Installation
Install the following dependencies:
```shell
go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional
```
Put the package under your project folder and add the following in import:
```golang
import "./geoclient"
```
## Documentation for API Endpoints
All URIs are relative to *https://geo.exploratory.engineering/api/v1*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*CollectionApi* | [**CreateCollection**](docs/CollectionApi.md#createcollection) | **Post** /collections | Create a new Collection
*CollectionApi* | [**DeleteCollection**](docs/CollectionApi.md#deletecollection) | **Delete** /collections/{collectionId} | Delete a Collection
*CollectionApi* | [**GetCollection**](docs/CollectionApi.md#getcollection) | **Get** /collections/{collectionId} | Get a single Collection
*CollectionApi* | [**GetCollections**](docs/CollectionApi.md#getcollections) | **Get** /collections | Get all Collections
*CollectionApi* | [**UpdateCollection**](docs/CollectionApi.md#updatecollection) | **Put** /collections/{collectionId} | Update a Collection
*PositionApi* | [**CreatePosition**](docs/PositionApi.md#createposition) | **Post** /collections/{collectionId}/trackers/{trackerId}/positions | Create a new position for the Tracker
*PositionApi* | [**GetPositions**](docs/PositionApi.md#getpositions) | **Get** /collections/{collectionId}/trackers/{trackerId}/positions | Get all Positions for Tracker
*ProfileApi* | [**GetProfile**](docs/ProfileApi.md#getprofile) | **Get** /profile | Get authenticated Profile
*ShapeCollectionApi* | [**CreateShapeCollection**](docs/ShapeCollectionApi.md#createshapecollection) | **Post** /shapecollections | Create a new ShapeCollection
*ShapeCollectionApi* | [**CreateShapeCollectionFeature**](docs/ShapeCollectionApi.md#createshapecollectionfeature) | **Post** /shapecollections/{shapeCollectionId}/shapes | Create new GeoJSON Feature
*ShapeCollectionApi* | [**DeleteShape**](docs/ShapeCollectionApi.md#deleteshape) | **Delete** /shapecollections/{shapeCollectionId}/shapes/{shapeId} | Delete a Shape
*ShapeCollectionApi* | [**DeleteShapeCollection**](docs/ShapeCollectionApi.md#deleteshapecollection) | **Delete** /shapecollections/{shapeCollectionId} | Delete a ShapeCollection
*ShapeCollectionApi* | [**GetShape**](docs/ShapeCollectionApi.md#getshape) | **Get** /shapecollections/{shapeCollectionId}/shapes/{shapeId} | Get Shape
*ShapeCollectionApi* | [**GetShapeCollection**](docs/ShapeCollectionApi.md#getshapecollection) | **Get** /shapecollections/{shapeCollectionId} | Get a single ShapeCollection
*ShapeCollectionApi* | [**GetShapeCollectionFeatureCollection**](docs/ShapeCollectionApi.md#getshapecollectionfeaturecollection) | **Get** /shapecollections/{shapeCollectionId}/geojson | Get a GeoJSON FeatureCollection for a ShapeCollection
*ShapeCollectionApi* | [**GetShapeCollectionShapes**](docs/ShapeCollectionApi.md#getshapecollectionshapes) | **Get** /shapecollections/{shapeCollectionId}/shapes | Get Shapes for a ShapeCollection
*ShapeCollectionApi* | [**GetShapeCollections**](docs/ShapeCollectionApi.md#getshapecollections) | **Get** /shapecollections | Get all ShapeCollections
*ShapeCollectionApi* | [**GetShapeFeature**](docs/ShapeCollectionApi.md#getshapefeature) | **Get** /shapecollections/{shapeCollectionId}/shapes/{shapeId}/geojson | Get Shape GeoJSON Feature
*ShapeCollectionApi* | [**ReplaceShapeCollectionFeature**](docs/ShapeCollectionApi.md#replaceshapecollectionfeature) | **Put** /shapecollections/{shapeCollectionId}/shapes/{shapeId}/geojson | Replace Shape GeoJSON Feature
*ShapeCollectionApi* | [**ReplaceShapeCollectionFeatureCollection**](docs/ShapeCollectionApi.md#replaceshapecollectionfeaturecollection) | **Put** /shapecollections/{shapeCollectionId}/geojson | Replace GeoJSON FeatureCollection
*ShapeCollectionApi* | [**UpdateShapeCollection**](docs/ShapeCollectionApi.md#updateshapecollection) | **Put** /shapecollections/{shapeCollectionId} | Edit a ShapeCollection
*SubscriptionApi* | [**CreateSubscription**](docs/SubscriptionApi.md#createsubscription) | **Post** /subscriptions | Create a new Subscription
*SubscriptionApi* | [**DeleteSubscription**](docs/SubscriptionApi.md#deletesubscription) | **Delete** /subscriptions/{subscriptionId} | Delete a Subscription
*SubscriptionApi* | [**GetSubscription**](docs/SubscriptionApi.md#getsubscription) | **Get** /subscriptions/{subscriptionId} | Get a single Subscription
*SubscriptionApi* | [**GetSubscriptions**](docs/SubscriptionApi.md#getsubscriptions) | **Get** /subscriptions | Get all Subscriptions
*SubscriptionApi* | [**UpdateSubscription**](docs/SubscriptionApi.md#updatesubscription) | **Put** /subscriptions/{subscriptionId} | Update a Subscription
*TeamApi* | [**CreateTeam**](docs/TeamApi.md#createteam) | **Post** /teams | Create a new Team
*TeamApi* | [**DeleteTeam**](docs/TeamApi.md#deleteteam) | **Delete** /teams/{teamId} | Delete a Team
*TeamApi* | [**GetTeam**](docs/TeamApi.md#getteam) | **Get** /teams/{teamId} | Get a single Team
*TeamApi* | [**GetTeams**](docs/TeamApi.md#getteams) | **Get** /teams | Get all Teams
*TeamApi* | [**UpdateTeam**](docs/TeamApi.md#updateteam) | **Put** /teams/{teamId} | Update a Team
*TrackerApi* | [**CreateTracker**](docs/TrackerApi.md#createtracker) | **Post** /collections/{collectionId}/trackers | Create a new Tracker
*TrackerApi* | [**DeleteTracker**](docs/TrackerApi.md#deletetracker) | **Delete** /collections/{collectionId}/trackers/{trackerId} | Delete a Tracker
*TrackerApi* | [**GetTracker**](docs/TrackerApi.md#gettracker) | **Get** /collections/{collectionId}/trackers/{trackerId} | Get a single Tracker
*TrackerApi* | [**GetTrackers**](docs/TrackerApi.md#gettrackers) | **Get** /collections/{collectionId}/trackers | Get all Trackers
*TrackerApi* | [**UpdateTracker**](docs/TrackerApi.md#updatetracker) | **Put** /collections/{collectionId}/trackers/{trackerId} | Update a Tracker
## Documentation For Models
- [BadRequestResponse](docs/BadRequestResponse.md)
- [CollectionResponse](docs/CollectionResponse.md)
- [EditCollectionRequest](docs/EditCollectionRequest.md)
- [EditShapeCollectionRequest](docs/EditShapeCollectionRequest.md)
- [EditSubscriptionRequest](docs/EditSubscriptionRequest.md)
- [EditTeamRequest](docs/EditTeamRequest.md)
- [EditTrackerRequest](docs/EditTrackerRequest.md)
- [ErrorDetail](docs/ErrorDetail.md)
- [NewCollectionRequest](docs/NewCollectionRequest.md)
- [NewPositionRequest](docs/NewPositionRequest.md)
- [NewShapeCollectionRequest](docs/NewShapeCollectionRequest.md)
- [NewSubscriptionRequest](docs/NewSubscriptionRequest.md)
- [NewTeamRequest](docs/NewTeamRequest.md)
- [NewTrackerRequest](docs/NewTrackerRequest.md)
- [NotFoundResponse](docs/NotFoundResponse.md)
- [PositionResponse](docs/PositionResponse.md)
- [ProfileResponse](docs/ProfileResponse.md)
- [ShapeCollectionResponse](docs/ShapeCollectionResponse.md)
- [ShapeResponse](docs/ShapeResponse.md)
- [SmsOutput](docs/SmsOutput.md)
- [SmsOutputAllOf](docs/SmsOutputAllOf.md)
- [SmsOutputAllOfConfig](docs/SmsOutputAllOfConfig.md)
- [SubscriptionConfidenceType](docs/SubscriptionConfidenceType.md)
- [SubscriptionOutput](docs/SubscriptionOutput.md)
- [SubscriptionResponse](docs/SubscriptionResponse.md)
- [SubscriptionResponseTrackable](docs/SubscriptionResponseTrackable.md)
- [SubscriptionResponseTriggerCriteria](docs/SubscriptionResponseTriggerCriteria.md)
- [SubscriptionTrackerType](docs/SubscriptionTrackerType.md)
- [SubscriptionTriggerType](docs/SubscriptionTriggerType.md)
- [TeamResponse](docs/TeamResponse.md)
- [TrackerResponse](docs/TrackerResponse.md)
- [UnauthorizedResponse](docs/UnauthorizedResponse.md)
- [WebSocketOutput](docs/WebSocketOutput.md)
- [WebhookOutput](docs/WebhookOutput.md)
- [WebhookOutputAllOf](docs/WebhookOutputAllOf.md)
- [WebhookOutputAllOfConfig](docs/WebhookOutputAllOfConfig.md)
## Documentation For Authorization
## APIToken
- **Type**: API key
Example
```golang
auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
Key: "APIKEY",
Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)
```
## Author