client

package
v0.0.0-...-9bbc724 Latest Latest
Warning

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

 Go to latest Published: Dec 27, 2024 License: MIT Imports: 21 Imported by: 2

README

Go API client for client

URL Shortener is an API for managing short URLs

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
  • Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://about.gomezignacio.com

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

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

import client "github.com/igomez10/microservices"

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 client.ContextServerIndex of type int.

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

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

ctx := context.WithValue(context.Background(), client.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 client.ContextOperationServerIndices and client.ContextOperationServerVariables context maps.

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

Documentation for API Endpoints

All URIs are relative to https://urlshortener.gomezignacio.com

Class Method HTTP request Description
URLAPI CreateUrl Post /v1/urls Create a new url
URLAPI DeleteUrl Delete /v1/urls/{alias} Delete a url
URLAPI GetUrl Get /v1/urls/{alias} Get a url
URLAPI GetUrlData Get /v1/urls/{alias}/data Returns a url metadata

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

BasicAuth
  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), client.ContextBasicAuth, client.BasicAuth{
	UserName: "username",
	Password: "password",
})
r, err := client.Service.Operation(auth, args)
OAuth2
  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes:
  • shortly.url.create: Create a url
  • shortly.url.update: Update a url
  • shortly.url.delete: Delete a url

Example

auth := context.WithValue(context.Background(), client.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, client.ContextOAuth2, tokenSource)
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

ignacio.gomez.arboleda@gmail.com

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 (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// 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 {
	URLAPI *URLAPIService
	// contains filtered or unexported fields
}

APIClient manages communication with the URL Shortener 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 ApiCreateUrlRequest 

type ApiCreateUrlRequest struct {
	ApiService *URLAPIService
	// contains filtered or unexported fields
}

func (ApiCreateUrlRequest) Execute 

func (r ApiCreateUrlRequest) Execute() (*URL, *http.Response, error)

func (ApiCreateUrlRequest) URL 

func (r ApiCreateUrlRequest) URL(uRL URL) ApiCreateUrlRequest

Create a new url

func (ApiCreateUrlRequest) XRequestID 

func (r ApiCreateUrlRequest) XRequestID(xRequestID string) ApiCreateUrlRequest

Request ID

type ApiDeleteUrlRequest 

type ApiDeleteUrlRequest struct {
	ApiService *URLAPIService
	// contains filtered or unexported fields
}

func (ApiDeleteUrlRequest) Execute 

func (r ApiDeleteUrlRequest) Execute() (*http.Response, error)

func (ApiDeleteUrlRequest) XRequestID 

func (r ApiDeleteUrlRequest) XRequestID(xRequestID string) ApiDeleteUrlRequest

Request ID

type ApiGetUrlDataRequest 

type ApiGetUrlDataRequest struct {
	ApiService *URLAPIService
	// contains filtered or unexported fields
}

func (ApiGetUrlDataRequest) Execute 

func (r ApiGetUrlDataRequest) Execute() (*URL, *http.Response, error)

func (ApiGetUrlDataRequest) XRequestID 

func (r ApiGetUrlDataRequest) XRequestID(xRequestID string) ApiGetUrlDataRequest

Request ID

type ApiGetUrlRequest 

type ApiGetUrlRequest struct {
	ApiService *URLAPIService
	// contains filtered or unexported fields
}

func (ApiGetUrlRequest) Execute 

func (r ApiGetUrlRequest) Execute() (*http.Response, error)

func (ApiGetUrlRequest) XRequestID 

func (r ApiGetUrlRequest) XRequestID(xRequestID string) ApiGetUrlRequest

Request ID

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 Error 

type Error struct {
	Code    int32  `json:"code"`
	Message string `json:"message"`
}

Error struct for Error

func NewError 

func NewError(code int32, message string) *Error

NewError instantiates a new Error 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 NewErrorWithDefaults 

func NewErrorWithDefaults() *Error

NewErrorWithDefaults instantiates a new Error 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 (*Error) GetCode 

func (o *Error) GetCode() int32

GetCode returns the Code field value

func (*Error) GetCodeOk 

func (o *Error) GetCodeOk() (*int32, bool)

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

func (*Error) GetMessage 

func (o *Error) GetMessage() string

GetMessage returns the Message field value

func (*Error) GetMessageOk 

func (o *Error) GetMessageOk() (*string, bool)

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

func (Error) MarshalJSON 

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

func (*Error) SetCode 

func (o *Error) SetCode(v int32)

SetCode sets field value

func (*Error) SetMessage 

func (o *Error) SetMessage(v string)

SetMessage sets field value

func (Error) ToMap 

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

func (*Error) UnmarshalJSON 

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

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 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 NullableError 

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

func NewNullableError 

func NewNullableError(val *Error) *NullableError

func (NullableError) Get 

func (v NullableError) Get() *Error

func (NullableError) IsSet 

func (v NullableError) IsSet() bool

func (NullableError) MarshalJSON 

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

func (*NullableError) Set 

func (v *NullableError) Set(val *Error)

func (*NullableError) UnmarshalJSON 

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

func (*NullableError) Unset 

func (v *NullableError) 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 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 NullableURL 

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

func NewNullableURL 

func NewNullableURL(val *URL) *NullableURL

func (NullableURL) Get 

func (v NullableURL) Get() *URL

func (NullableURL) IsSet 

func (v NullableURL) IsSet() bool

func (NullableURL) MarshalJSON 

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

func (*NullableURL) Set 

func (v *NullableURL) Set(val *URL)

func (*NullableURL) UnmarshalJSON 

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

func (*NullableURL) Unset 

func (v *NullableURL) 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 URL 

type URL struct {
	Url       string     `json:"url"`
	Alias     string     `json:"alias"`
	CreatedAt *time.Time `json:"created_at,omitempty"`
	UpdatedAt *time.Time `json:"updated_at,omitempty"`
	DeletedAt *time.Time `json:"deleted_at,omitempty"`
}

URL struct for URL

func NewURL 

func NewURL(url string, alias string) *URL

NewURL instantiates a new URL 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 NewURLWithDefaults 

func NewURLWithDefaults() *URL

NewURLWithDefaults instantiates a new URL 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 (*URL) GetAlias 

func (o *URL) GetAlias() string

GetAlias returns the Alias field value

func (*URL) GetAliasOk 

func (o *URL) GetAliasOk() (*string, bool)

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

func (*URL) GetCreatedAt 

func (o *URL) GetCreatedAt() time.Time

GetCreatedAt returns the CreatedAt field value if set, zero value otherwise.

func (*URL) GetCreatedAtOk 

func (o *URL) GetCreatedAtOk() (*time.Time, bool)

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

func (*URL) GetDeletedAt 

func (o *URL) GetDeletedAt() time.Time

GetDeletedAt returns the DeletedAt field value if set, zero value otherwise.

func (*URL) GetDeletedAtOk 

func (o *URL) GetDeletedAtOk() (*time.Time, bool)

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

func (*URL) GetUpdatedAt 

func (o *URL) GetUpdatedAt() time.Time

GetUpdatedAt returns the UpdatedAt field value if set, zero value otherwise.

func (*URL) GetUpdatedAtOk 

func (o *URL) GetUpdatedAtOk() (*time.Time, bool)

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

func (*URL) GetUrl 

func (o *URL) GetUrl() string

GetUrl returns the Url field value

func (*URL) GetUrlOk 

func (o *URL) GetUrlOk() (*string, bool)

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

func (*URL) HasCreatedAt 

func (o *URL) HasCreatedAt() bool

HasCreatedAt returns a boolean if a field has been set.

func (*URL) HasDeletedAt 

func (o *URL) HasDeletedAt() bool

HasDeletedAt returns a boolean if a field has been set.

func (*URL) HasUpdatedAt 

func (o *URL) HasUpdatedAt() bool

HasUpdatedAt returns a boolean if a field has been set.

func (URL) MarshalJSON 

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

func (*URL) SetAlias 

func (o *URL) SetAlias(v string)

SetAlias sets field value

func (*URL) SetCreatedAt 

func (o *URL) SetCreatedAt(v time.Time)

SetCreatedAt gets a reference to the given time.Time and assigns it to the CreatedAt field.

func (*URL) SetDeletedAt 

func (o *URL) SetDeletedAt(v time.Time)

SetDeletedAt gets a reference to the given time.Time and assigns it to the DeletedAt field.

func (*URL) SetUpdatedAt 

func (o *URL) SetUpdatedAt(v time.Time)

SetUpdatedAt gets a reference to the given time.Time and assigns it to the UpdatedAt field.

func (*URL) SetUrl 

func (o *URL) SetUrl(v string)

SetUrl sets field value

func (URL) ToMap 

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

func (*URL) UnmarshalJSON 

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

type URLAPIService 

type URLAPIService service

URLAPIService URLAPI service

func (*URLAPIService) CreateUrl 

func (a *URLAPIService) CreateUrl(ctx context.Context) ApiCreateUrlRequest

CreateUrl Create a new url

Returns a url 

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

func (*URLAPIService) CreateUrlExecute 

func (a *URLAPIService) CreateUrlExecute(r ApiCreateUrlRequest) (*URL, *http.Response, error)

Execute executes the request 

@return URL

func (*URLAPIService) DeleteUrl 

func (a *URLAPIService) DeleteUrl(ctx context.Context, alias string) ApiDeleteUrlRequest

DeleteUrl Delete a url

Delete a url 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param alias The alias of the url
@return ApiDeleteUrlRequest

func (*URLAPIService) DeleteUrlExecute 

func (a *URLAPIService) DeleteUrlExecute(r ApiDeleteUrlRequest) (*http.Response, error)

Execute executes the request

func (*URLAPIService) GetUrl 

func (a *URLAPIService) GetUrl(ctx context.Context, alias string) ApiGetUrlRequest

GetUrl Get a url

Returns a url 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param alias The alias of the url
@return ApiGetUrlRequest

func (*URLAPIService) GetUrlData 

func (a *URLAPIService) GetUrlData(ctx context.Context, alias string) ApiGetUrlDataRequest

GetUrlData Returns a url metadata

Returns a url 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param alias The alias of the url
@return ApiGetUrlDataRequest

func (*URLAPIService) GetUrlDataExecute 

func (a *URLAPIService) GetUrlDataExecute(r ApiGetUrlDataRequest) (*URL, *http.Response, error)

Execute executes the request 

@return URL

func (*URLAPIService) GetUrlExecute 

func (a *URLAPIService) GetUrlExecute(r ApiGetUrlRequest) (*http.Response, error)

Execute executes the request

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.