ipdetective

package module
v1.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 7, 2024 License: MIT Imports: 20 Imported by: 0

README

Go API client for ipdetective

IPDetective API IP bot detection and IP geolocation

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: 1.0.0
  • Package version: 1.0.0
  • Generator version: 7.10.0-SNAPSHOT
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import ipdetective "github.com/AndrewCopeland/go-ipdetective"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value ipdetective.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), ipdetective.ContextServerIndex, 1)
Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value ipdetective.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), ipdetective.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using ipdetective.ContextOperationServerIndices and ipdetective.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), ipdetective.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), ipdetective.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://api.ipdetective.io

Class Method HTTP request Description
DefaultAPI GetBulkIP Post /ip Bulk IP Lookup
DefaultAPI GetIP Get /ip/{ip} Single IP Lookup
DefaultAPI GetMyIP Get /ip My IP
DefaultAPI GetUsage Get /usage API Usage

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

ApiKeyAuth
  • Type: API key
  • API key parameter name: x-api-key
  • Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: ApiKeyAuth and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		ipdetective.ContextAPIKeys,
		map[string]ipdetective.APIKey{
			"ApiKeyAuth": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	JsonCheck = regexp.MustCompile(`(?i:(?:application|text)/(?:[^;]+\+)?json)`)
	XmlCheck  = regexp.MustCompile(`(?i:(?:application|text)/(?:[^;]+\+)?xml)`)
)
View Source 
var (
	// ContextAPIKeys takes a string apikey as authentication for the request
	ContextAPIKeys = contextKey("apiKeys")

	// ContextServerIndex uses a server configuration from the index.
	ContextServerIndex = contextKey("serverIndex")

	// ContextOperationServerIndices uses a server configuration from the index mapping.
	ContextOperationServerIndices = contextKey("serverOperationIndices")

	// ContextServerVariables overrides a server configuration variables.
	ContextServerVariables = contextKey("serverVariables")

	// ContextOperationServerVariables overrides a server configuration variables using operation specific values.
	ContextOperationServerVariables = contextKey("serverOperationVariables")
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

func IsNil 

func IsNil(i interface{}) bool

IsNil checks if an input is nil

func PtrBool 

func PtrBool(v bool) *bool

PtrBool is a helper routine that returns a pointer to given boolean value.

func PtrFloat32 

func PtrFloat32(v float32) *float32

PtrFloat32 is a helper routine that returns a pointer to given float value.

func PtrFloat64 

func PtrFloat64(v float64) *float64

PtrFloat64 is a helper routine that returns a pointer to given float value.

func PtrInt 

func PtrInt(v int) *int

PtrInt is a helper routine that returns a pointer to given integer value.

func PtrInt32 

func PtrInt32(v int32) *int32

PtrInt32 is a helper routine that returns a pointer to given integer value.

func PtrInt64 

func PtrInt64(v int64) *int64

PtrInt64 is a helper routine that returns a pointer to given integer value.

func PtrString 

func PtrString(v string) *string

PtrString is a helper routine that returns a pointer to given string value.

func PtrTime 

func PtrTime(v time.Time) *time.Time

PtrTime is helper routine that returns a pointer to given Time value.

Types

type APIClient 

type APIClient struct {
	DefaultAPI *DefaultAPIService
	// contains filtered or unexported fields
}

APIClient manages communication with the IPDetective API API v1.0.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) GetConfig 

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResponse object.

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type ApiGetBulkIPRequest 

type ApiGetBulkIPRequest struct {
	ApiService *DefaultAPIService
	// contains filtered or unexported fields
}

func (ApiGetBulkIPRequest) Execute 

func (r ApiGetBulkIPRequest) Execute() ([]IPResponse, *http.Response, error)

func (ApiGetBulkIPRequest) Info 

func (r ApiGetBulkIPRequest) Info(info bool) ApiGetBulkIPRequest

If true, returns additional info like country and ASN for each IP.

func (ApiGetBulkIPRequest) RequestBody 

func (r ApiGetBulkIPRequest) RequestBody(requestBody []string) ApiGetBulkIPRequest

type ApiGetIPRequest 

type ApiGetIPRequest struct {
	ApiService *DefaultAPIService
	// contains filtered or unexported fields
}

func (ApiGetIPRequest) Execute 

func (r ApiGetIPRequest) Execute() (*IPResponse, *http.Response, error)

func (ApiGetIPRequest) Info 

func (r ApiGetIPRequest) Info(info bool) ApiGetIPRequest

If true, returns additional info like country and ASN.

type ApiGetMyIPRequest 

type ApiGetMyIPRequest struct {
	ApiService *DefaultAPIService
	// contains filtered or unexported fields
}

func (ApiGetMyIPRequest) Execute 

func (r ApiGetMyIPRequest) Execute() (*IPResponse, *http.Response, error)

func (ApiGetMyIPRequest) Info 

func (r ApiGetMyIPRequest) Info(info bool) ApiGetMyIPRequest

If true, returns additional info like country and ASN.

type ApiGetUsageRequest 

type ApiGetUsageRequest struct {
	ApiService *DefaultAPIService
	// contains filtered or unexported fields
}

func (ApiGetUsageRequest) Execute 

func (r ApiGetUsageRequest) Execute() (*UsageResponse, *http.Response, error)

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Configuration 

type Configuration struct {
	Host             string            `json:"host,omitempty"`
	Scheme           string            `json:"scheme,omitempty"`
	DefaultHeader    map[string]string `json:"defaultHeader,omitempty"`
	UserAgent        string            `json:"userAgent,omitempty"`
	Debug            bool              `json:"debug,omitempty"`
	Servers          ServerConfigurations
	OperationServers map[string]ServerConfigurations
	HTTPClient       *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration 

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerURL 

func (c *Configuration) ServerURL(index int, variables map[string]string) (string, error)

ServerURL returns URL based on server settings

func (*Configuration) ServerURLWithContext 

func (c *Configuration) ServerURLWithContext(ctx context.Context, endpoint string) (string, error)

ServerURLWithContext returns a new server URL given an endpoint

type DefaultAPIService 

type DefaultAPIService service

DefaultAPIService DefaultAPI service

func (*DefaultAPIService) GetBulkIP 

func (a *DefaultAPIService) GetBulkIP(ctx context.Context) ApiGetBulkIPRequest

GetBulkIP Bulk IP Lookup

Lookup multiple IP addresses in one request. Maximum of 1,000 IPs per request. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetBulkIPRequest

func (*DefaultAPIService) GetBulkIPExecute 

func (a *DefaultAPIService) GetBulkIPExecute(r ApiGetBulkIPRequest) ([]IPResponse, *http.Response, error)

Execute executes the request 

@return []IPResponse

func (*DefaultAPIService) GetIP 

func (a *DefaultAPIService) GetIP(ctx context.Context, ip string) ApiGetIPRequest

GetIP Single IP Lookup

Lookup a specific IP address. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param ip
@return ApiGetIPRequest

func (*DefaultAPIService) GetIPExecute 

func (a *DefaultAPIService) GetIPExecute(r ApiGetIPRequest) (*IPResponse, *http.Response, error)

Execute executes the request 

@return IPResponse

func (*DefaultAPIService) GetMyIP 

func (a *DefaultAPIService) GetMyIP(ctx context.Context) ApiGetMyIPRequest

GetMyIP My IP

Retrieve information about the caller's IP address. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetMyIPRequest

func (*DefaultAPIService) GetMyIPExecute 

func (a *DefaultAPIService) GetMyIPExecute(r ApiGetMyIPRequest) (*IPResponse, *http.Response, error)

Execute executes the request 

@return IPResponse

func (*DefaultAPIService) GetUsage 

func (a *DefaultAPIService) GetUsage(ctx context.Context) ApiGetUsageRequest

GetUsage API Usage

Retrieve current API usage details, including request and lookup limits. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetUsageRequest

func (*DefaultAPIService) GetUsageExecute 

func (a *DefaultAPIService) GetUsageExecute(r ApiGetUsageRequest) (*UsageResponse, *http.Response, error)

Execute executes the request 

@return UsageResponse

type GenericOpenAPIError 

type GenericOpenAPIError struct {
	// contains filtered or unexported fields
}

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body 

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error 

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model 

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type IPResponse 

type IPResponse struct {
	Ip             string  `json:"ip"`
	Bot            bool    `json:"bot"`
	Type           *string `json:"type,omitempty"`
	Asn            *int32  `json:"asn,omitempty"`
	AsnDescription *string `json:"asn_description,omitempty"`
	CountryCode    *string `json:"country_code,omitempty"`
	CountryName    *string `json:"country_name,omitempty"`
}

IPResponse struct for IPResponse

func NewIPResponse 

func NewIPResponse(ip string, bot bool) *IPResponse

NewIPResponse instantiates a new IPResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewIPResponseWithDefaults 

func NewIPResponseWithDefaults() *IPResponse

NewIPResponseWithDefaults instantiates a new IPResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*IPResponse) GetAsn 

func (o *IPResponse) GetAsn() int32

GetAsn returns the Asn field value if set, zero value otherwise.

func (*IPResponse) GetAsnDescription 

func (o *IPResponse) GetAsnDescription() string

GetAsnDescription returns the AsnDescription field value if set, zero value otherwise.

func (*IPResponse) GetAsnDescriptionOk 

func (o *IPResponse) GetAsnDescriptionOk() (*string, bool)

GetAsnDescriptionOk returns a tuple with the AsnDescription field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IPResponse) GetAsnOk 

func (o *IPResponse) GetAsnOk() (*int32, bool)

GetAsnOk returns a tuple with the Asn field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IPResponse) GetBot 

func (o *IPResponse) GetBot() bool

GetBot returns the Bot field value

func (*IPResponse) GetBotOk 

func (o *IPResponse) GetBotOk() (*bool, bool)

GetBotOk returns a tuple with the Bot field value and a boolean to check if the value has been set.

func (*IPResponse) GetCountryCode 

func (o *IPResponse) GetCountryCode() string

GetCountryCode returns the CountryCode field value if set, zero value otherwise.

func (*IPResponse) GetCountryCodeOk 

func (o *IPResponse) GetCountryCodeOk() (*string, bool)

GetCountryCodeOk returns a tuple with the CountryCode field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IPResponse) GetCountryName 

func (o *IPResponse) GetCountryName() string

GetCountryName returns the CountryName field value if set, zero value otherwise.

func (*IPResponse) GetCountryNameOk 

func (o *IPResponse) GetCountryNameOk() (*string, bool)

GetCountryNameOk returns a tuple with the CountryName field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IPResponse) GetIp 

func (o *IPResponse) GetIp() string

GetIp returns the Ip field value

func (*IPResponse) GetIpOk 

func (o *IPResponse) GetIpOk() (*string, bool)

GetIpOk returns a tuple with the Ip field value and a boolean to check if the value has been set.

func (*IPResponse) GetType 

func (o *IPResponse) GetType() string

GetType returns the Type field value if set, zero value otherwise.

func (*IPResponse) GetTypeOk 

func (o *IPResponse) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IPResponse) HasAsn 

func (o *IPResponse) HasAsn() bool

HasAsn returns a boolean if a field has been set.

func (*IPResponse) HasAsnDescription 

func (o *IPResponse) HasAsnDescription() bool

HasAsnDescription returns a boolean if a field has been set.

func (*IPResponse) HasCountryCode 

func (o *IPResponse) HasCountryCode() bool

HasCountryCode returns a boolean if a field has been set.

func (*IPResponse) HasCountryName 

func (o *IPResponse) HasCountryName() bool

HasCountryName returns a boolean if a field has been set.

func (*IPResponse) HasType 

func (o *IPResponse) HasType() bool

HasType returns a boolean if a field has been set.

func (IPResponse) MarshalJSON 

func (o IPResponse) MarshalJSON() ([]byte, error)

func (*IPResponse) SetAsn 

func (o *IPResponse) SetAsn(v int32)

SetAsn gets a reference to the given int32 and assigns it to the Asn field.

func (*IPResponse) SetAsnDescription 

func (o *IPResponse) SetAsnDescription(v string)

SetAsnDescription gets a reference to the given string and assigns it to the AsnDescription field.

func (*IPResponse) SetBot 

func (o *IPResponse) SetBot(v bool)

SetBot sets field value

func (*IPResponse) SetCountryCode 

func (o *IPResponse) SetCountryCode(v string)

SetCountryCode gets a reference to the given string and assigns it to the CountryCode field.

func (*IPResponse) SetCountryName 

func (o *IPResponse) SetCountryName(v string)

SetCountryName gets a reference to the given string and assigns it to the CountryName field.

func (*IPResponse) SetIp 

func (o *IPResponse) SetIp(v string)

SetIp sets field value

func (*IPResponse) SetType 

func (o *IPResponse) SetType(v string)

SetType gets a reference to the given string and assigns it to the Type field.

func (IPResponse) ToMap 

func (o IPResponse) ToMap() (map[string]interface{}, error)

func (*IPResponse) UnmarshalJSON 

func (o *IPResponse) UnmarshalJSON(data []byte) (err error)

type MappedNullable 

type MappedNullable interface {
	ToMap() (map[string]interface{}, error)
}

type NullableBool 

type NullableBool struct {
	// contains filtered or unexported fields
}

func NewNullableBool 

func NewNullableBool(val *bool) *NullableBool

func (NullableBool) Get 

func (v NullableBool) Get() *bool

func (NullableBool) IsSet 

func (v NullableBool) IsSet() bool

func (NullableBool) MarshalJSON 

func (v NullableBool) MarshalJSON() ([]byte, error)

func (*NullableBool) Set 

func (v *NullableBool) Set(val *bool)

func (*NullableBool) UnmarshalJSON 

func (v *NullableBool) UnmarshalJSON(src []byte) error

func (*NullableBool) Unset 

func (v *NullableBool) Unset()

type NullableFloat32 

type NullableFloat32 struct {
	// contains filtered or unexported fields
}

func NewNullableFloat32 

func NewNullableFloat32(val *float32) *NullableFloat32

func (NullableFloat32) Get 

func (v NullableFloat32) Get() *float32

func (NullableFloat32) IsSet 

func (v NullableFloat32) IsSet() bool

func (NullableFloat32) MarshalJSON 

func (v NullableFloat32) MarshalJSON() ([]byte, error)

func (*NullableFloat32) Set 

func (v *NullableFloat32) Set(val *float32)

func (*NullableFloat32) UnmarshalJSON 

func (v *NullableFloat32) UnmarshalJSON(src []byte) error

func (*NullableFloat32) Unset 

func (v *NullableFloat32) Unset()

type NullableFloat64 

type NullableFloat64 struct {
	// contains filtered or unexported fields
}

func NewNullableFloat64 

func NewNullableFloat64(val *float64) *NullableFloat64

func (NullableFloat64) Get 

func (v NullableFloat64) Get() *float64

func (NullableFloat64) IsSet 

func (v NullableFloat64) IsSet() bool

func (NullableFloat64) MarshalJSON 

func (v NullableFloat64) MarshalJSON() ([]byte, error)

func (*NullableFloat64) Set 

func (v *NullableFloat64) Set(val *float64)

func (*NullableFloat64) UnmarshalJSON 

func (v *NullableFloat64) UnmarshalJSON(src []byte) error

func (*NullableFloat64) Unset 

func (v *NullableFloat64) Unset()

type NullableIPResponse 

type NullableIPResponse struct {
	// contains filtered or unexported fields
}

func NewNullableIPResponse 

func NewNullableIPResponse(val *IPResponse) *NullableIPResponse

func (NullableIPResponse) Get 

func (v NullableIPResponse) Get() *IPResponse

func (NullableIPResponse) IsSet 

func (v NullableIPResponse) IsSet() bool

func (NullableIPResponse) MarshalJSON 

func (v NullableIPResponse) MarshalJSON() ([]byte, error)

func (*NullableIPResponse) Set 

func (v *NullableIPResponse) Set(val *IPResponse)

func (*NullableIPResponse) UnmarshalJSON 

func (v *NullableIPResponse) UnmarshalJSON(src []byte) error

func (*NullableIPResponse) Unset 

func (v *NullableIPResponse) Unset()

type NullableInt 

type NullableInt struct {
	// contains filtered or unexported fields
}

func NewNullableInt 

func NewNullableInt(val *int) *NullableInt

func (NullableInt) Get 

func (v NullableInt) Get() *int

func (NullableInt) IsSet 

func (v NullableInt) IsSet() bool

func (NullableInt) MarshalJSON 

func (v NullableInt) MarshalJSON() ([]byte, error)

func (*NullableInt) Set 

func (v *NullableInt) Set(val *int)

func (*NullableInt) UnmarshalJSON 

func (v *NullableInt) UnmarshalJSON(src []byte) error

func (*NullableInt) Unset 

func (v *NullableInt) Unset()

type NullableInt32 

type NullableInt32 struct {
	// contains filtered or unexported fields
}

func NewNullableInt32 

func NewNullableInt32(val *int32) *NullableInt32

func (NullableInt32) Get 

func (v NullableInt32) Get() *int32

func (NullableInt32) IsSet 

func (v NullableInt32) IsSet() bool

func (NullableInt32) MarshalJSON 

func (v NullableInt32) MarshalJSON() ([]byte, error)

func (*NullableInt32) Set 

func (v *NullableInt32) Set(val *int32)

func (*NullableInt32) UnmarshalJSON 

func (v *NullableInt32) UnmarshalJSON(src []byte) error

func (*NullableInt32) Unset 

func (v *NullableInt32) Unset()

type NullableInt64 

type NullableInt64 struct {
	// contains filtered or unexported fields
}

func NewNullableInt64 

func NewNullableInt64(val *int64) *NullableInt64

func (NullableInt64) Get 

func (v NullableInt64) Get() *int64

func (NullableInt64) IsSet 

func (v NullableInt64) IsSet() bool

func (NullableInt64) MarshalJSON 

func (v NullableInt64) MarshalJSON() ([]byte, error)

func (*NullableInt64) Set 

func (v *NullableInt64) Set(val *int64)

func (*NullableInt64) UnmarshalJSON 

func (v *NullableInt64) UnmarshalJSON(src []byte) error

func (*NullableInt64) Unset 

func (v *NullableInt64) Unset()

type NullableString 

type NullableString struct {
	// contains filtered or unexported fields
}

func NewNullableString 

func NewNullableString(val *string) *NullableString

func (NullableString) Get 

func (v NullableString) Get() *string

func (NullableString) IsSet 

func (v NullableString) IsSet() bool

func (NullableString) MarshalJSON 

func (v NullableString) MarshalJSON() ([]byte, error)

func (*NullableString) Set 

func (v *NullableString) Set(val *string)

func (*NullableString) UnmarshalJSON 

func (v *NullableString) UnmarshalJSON(src []byte) error

func (*NullableString) Unset 

func (v *NullableString) Unset()

type NullableTime 

type NullableTime struct {
	// contains filtered or unexported fields
}

func NewNullableTime 

func NewNullableTime(val *time.Time) *NullableTime

func (NullableTime) Get 

func (v NullableTime) Get() *time.Time

func (NullableTime) IsSet 

func (v NullableTime) IsSet() bool

func (NullableTime) MarshalJSON 

func (v NullableTime) MarshalJSON() ([]byte, error)

func (*NullableTime) Set 

func (v *NullableTime) Set(val *time.Time)

func (*NullableTime) UnmarshalJSON 

func (v *NullableTime) UnmarshalJSON(src []byte) error

func (*NullableTime) Unset 

func (v *NullableTime) Unset()

type NullableUsageResponse 

type NullableUsageResponse struct {
	// contains filtered or unexported fields
}

func NewNullableUsageResponse 

func NewNullableUsageResponse(val *UsageResponse) *NullableUsageResponse

func (NullableUsageResponse) Get 

func (v NullableUsageResponse) Get() *UsageResponse

func (NullableUsageResponse) IsSet 

func (v NullableUsageResponse) IsSet() bool

func (NullableUsageResponse) MarshalJSON 

func (v NullableUsageResponse) MarshalJSON() ([]byte, error)

func (*NullableUsageResponse) Set 

func (v *NullableUsageResponse) Set(val *UsageResponse)

func (*NullableUsageResponse) UnmarshalJSON 

func (v *NullableUsageResponse) UnmarshalJSON(src []byte) error

func (*NullableUsageResponse) Unset 

func (v *NullableUsageResponse) Unset()

type ServerConfiguration 

type ServerConfiguration struct {
	URL         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerConfigurations 

type ServerConfigurations []ServerConfiguration

ServerConfigurations stores multiple ServerConfiguration items

func (ServerConfigurations) URL 

func (sc ServerConfigurations) URL(index int, variables map[string]string) (string, error)

URL formats template on a index using given variables

type ServerVariable 

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

type UsageResponse 

type UsageResponse struct {
	RequestLimit *int32 `json:"request_limit,omitempty"`
	LookupLimit  *int32 `json:"lookup_limit,omitempty"`
	RequestHits  *int32 `json:"request_hits,omitempty"`
	LookupHits   *int32 `json:"lookup_hits,omitempty"`
}

UsageResponse struct for UsageResponse

func NewUsageResponse 

func NewUsageResponse() *UsageResponse

NewUsageResponse instantiates a new UsageResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewUsageResponseWithDefaults 

func NewUsageResponseWithDefaults() *UsageResponse

NewUsageResponseWithDefaults instantiates a new UsageResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*UsageResponse) GetLookupHits 

func (o *UsageResponse) GetLookupHits() int32

GetLookupHits returns the LookupHits field value if set, zero value otherwise.

func (*UsageResponse) GetLookupHitsOk 

func (o *UsageResponse) GetLookupHitsOk() (*int32, bool)

GetLookupHitsOk returns a tuple with the LookupHits field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsageResponse) GetLookupLimit 

func (o *UsageResponse) GetLookupLimit() int32

GetLookupLimit returns the LookupLimit field value if set, zero value otherwise.

func (*UsageResponse) GetLookupLimitOk 

func (o *UsageResponse) GetLookupLimitOk() (*int32, bool)

GetLookupLimitOk returns a tuple with the LookupLimit field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsageResponse) GetRequestHits 

func (o *UsageResponse) GetRequestHits() int32

GetRequestHits returns the RequestHits field value if set, zero value otherwise.

func (*UsageResponse) GetRequestHitsOk 

func (o *UsageResponse) GetRequestHitsOk() (*int32, bool)

GetRequestHitsOk returns a tuple with the RequestHits field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsageResponse) GetRequestLimit 

func (o *UsageResponse) GetRequestLimit() int32

GetRequestLimit returns the RequestLimit field value if set, zero value otherwise.

func (*UsageResponse) GetRequestLimitOk 

func (o *UsageResponse) GetRequestLimitOk() (*int32, bool)

GetRequestLimitOk returns a tuple with the RequestLimit field value if set, nil otherwise and a boolean to check if the value has been set.

func (*UsageResponse) HasLookupHits 

func (o *UsageResponse) HasLookupHits() bool

HasLookupHits returns a boolean if a field has been set.

func (*UsageResponse) HasLookupLimit 

func (o *UsageResponse) HasLookupLimit() bool

HasLookupLimit returns a boolean if a field has been set.

func (*UsageResponse) HasRequestHits 

func (o *UsageResponse) HasRequestHits() bool

HasRequestHits returns a boolean if a field has been set.

func (*UsageResponse) HasRequestLimit 

func (o *UsageResponse) HasRequestLimit() bool

HasRequestLimit returns a boolean if a field has been set.

func (UsageResponse) MarshalJSON 

func (o UsageResponse) MarshalJSON() ([]byte, error)

func (*UsageResponse) SetLookupHits 

func (o *UsageResponse) SetLookupHits(v int32)

SetLookupHits gets a reference to the given int32 and assigns it to the LookupHits field.

func (*UsageResponse) SetLookupLimit 

func (o *UsageResponse) SetLookupLimit(v int32)

SetLookupLimit gets a reference to the given int32 and assigns it to the LookupLimit field.

func (*UsageResponse) SetRequestHits 

func (o *UsageResponse) SetRequestHits(v int32)

SetRequestHits gets a reference to the given int32 and assigns it to the RequestHits field.

func (*UsageResponse) SetRequestLimit 

func (o *UsageResponse) SetRequestLimit(v int32)

SetRequestLimit gets a reference to the given int32 and assigns it to the RequestLimit field.

func (UsageResponse) ToMap 

func (o UsageResponse) ToMap() (map[string]interface{}, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.