package
0.0.0-20230705053459-e6c2022d9d35
Repository: https://github.com/unwiredlabs/locationapi-client-libraries.git
Documentation: pkg.go.dev

# README

Go API client for unwired

Geolocation, Geocoding and Maps

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 2.0.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

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:

import "./unwired"

Documentation for API Endpoints

All URIs are relative to https://us1.unwiredlabs.com/v2

ClassMethodHTTP requestDescription
BALANCEApiBalanceGet /balance.phpbalance
GEOLOCATIONApiGeolocationPost /process.phpGeolocation
REVERSEApiReverseGet /reverse.phpReverse Geocoding
SEARCHApiSearchGet /search.phpForward Geocoding
TimezoneApiTimezoneGet /timezone.phptimezone

Documentation For Models

Documentation For Authorization

token

  • Type: API key

Example

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

# Functions

CacheExpires helper function to determine remaining time before repeating a request.
NewAPIClient creates a new API client.
No description provided by the author
No description provided by the author
No description provided by the author

# Constants

List of radio_schema.
List of radio_schema.
List of radio_schema.
List of radio_schema.

# Variables

ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKey takes an APIKey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.

# Structs

The API only returns components that have valid values for a location.
Address object found for the search query.
APIClient manages communication with the Location API API v2.0.0 In most cases there should be only one, shared, APIClient.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
No description provided by the author
No description provided by the author
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
You can send 1 to 7 cell ID objects.
No description provided by the author
No description provided by the author
An array of fallback options to enable or disable.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
No description provided by the author
The response will be a JSON object.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Timezone object found for the location.
You can send a minimum of 2 and a maximum of 15 WiFi objects in 1 request.

# Type aliases

AllSchema : Enable or disable all fallbacks.
No description provided by the author
BtSchema : Specify level of strictness to apply to Borders.
GeolocationAddressSchema : The physical address of the returned location.
No description provided by the author
IpfSchema : Enable IP address fallback.
LacfSchema : Enable LAC fallback.
RadioSchema : Radio type of the device.
No description provided by the author
ScfSchema : Enable Short CID fallback.
No description provided by the author
No description provided by the author