paymentsapi

package module
v1.0.2 Latest Latest
Warning

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

 Go to latest Published: Mar 14, 2024 License: MPL-2.0 Imports: 21 Imported by: 2

README

Go API client for paymentsapi

Payments API are currently designed to fetch Transactions only.

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.

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 paymentsapi "github.com/phoenixnap/go-sdk-bmc/paymentsapi"

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

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

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

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

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

Documentation for API Endpoints

All URIs are relative to https://api.phoenixnap.com/payments/v1

Class Method HTTP request Description
TransactionsAPI TransactionIdGet Get /transactions/{transactionId} Get Transaction.
TransactionsAPI TransactionsGet Get /transactions Get Transactions.

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

OAuth2
  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes:
  • transactions: Grants full access to transactions.
  • transactions.read: Grants read only access to transactions.

Example

auth := context.WithValue(context.Background(), paymentsapi.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, paymentsapi.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

support@phoenixnap.com

Documentation

Index

Constants

View Source 
const SdkVersion = "1.0.2"

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")

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

APIClient manages communication with the Payments API API v0.1 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 ApiTransactionIdGetRequest 

type ApiTransactionIdGetRequest struct {
	ApiService TransactionsAPI
	// contains filtered or unexported fields
}

func (ApiTransactionIdGetRequest) Execute 

func (r ApiTransactionIdGetRequest) Execute() (*Transaction, *http.Response, error)

type ApiTransactionsGetRequest 

type ApiTransactionsGetRequest struct {
	ApiService TransactionsAPI
	// contains filtered or unexported fields
}

func (ApiTransactionsGetRequest) Execute 

func (r ApiTransactionsGetRequest) Execute() (*PaginatedTransactions, *http.Response, error)

func (ApiTransactionsGetRequest) From 

func (r ApiTransactionsGetRequest) From(from time.Time) ApiTransactionsGetRequest

From the date and time (inclusive) to filter transactions by.

func (ApiTransactionsGetRequest) Limit 

func (r ApiTransactionsGetRequest) Limit(limit int32) ApiTransactionsGetRequest

The limit of the number of results returned. The number of records returned may be smaller than the limit.

func (ApiTransactionsGetRequest) Offset 

func (r ApiTransactionsGetRequest) Offset(offset int32) ApiTransactionsGetRequest

The number of items to skip in the results.

func (ApiTransactionsGetRequest) SortDirection 

func (r ApiTransactionsGetRequest) SortDirection(sortDirection string) ApiTransactionsGetRequest

Sort Given Field depending on the desired direction. Default sorting is descending.

func (ApiTransactionsGetRequest) SortField 

func (r ApiTransactionsGetRequest) SortField(sortField string) ApiTransactionsGetRequest

If a sortField is requested, pagination will be done after sorting. Default sorting is by date.

func (ApiTransactionsGetRequest) To 

func (r ApiTransactionsGetRequest) To(to time.Time) ApiTransactionsGetRequest

To the date and time (inclusive) to filter transactions by.

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 CardPaymentMethodDetails 

type CardPaymentMethodDetails struct {
	// The Card Type. Supported Card Types include: VISA, MASTERCARD, DISCOVER, JCB & AMEX.
	CardType string `json:"cardType"`
	// The last four digits of the card number.
	LastFourDigits       string `json:"lastFourDigits"`
	AdditionalProperties map[string]interface{}
}

CardPaymentMethodDetails Card payment details of a transaction.

func NewCardPaymentMethodDetails 

func NewCardPaymentMethodDetails(cardType string, lastFourDigits string) *CardPaymentMethodDetails

NewCardPaymentMethodDetails instantiates a new CardPaymentMethodDetails 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 NewCardPaymentMethodDetailsWithDefaults 

func NewCardPaymentMethodDetailsWithDefaults() *CardPaymentMethodDetails

NewCardPaymentMethodDetailsWithDefaults instantiates a new CardPaymentMethodDetails 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 (*CardPaymentMethodDetails) GetCardType 

func (o *CardPaymentMethodDetails) GetCardType() string

GetCardType returns the CardType field value

func (*CardPaymentMethodDetails) GetCardTypeOk 

func (o *CardPaymentMethodDetails) GetCardTypeOk() (*string, bool)

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

func (*CardPaymentMethodDetails) GetLastFourDigits 

func (o *CardPaymentMethodDetails) GetLastFourDigits() string

GetLastFourDigits returns the LastFourDigits field value

func (*CardPaymentMethodDetails) GetLastFourDigitsOk 

func (o *CardPaymentMethodDetails) GetLastFourDigitsOk() (*string, bool)

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

func (CardPaymentMethodDetails) MarshalJSON 

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

func (*CardPaymentMethodDetails) SetCardType 

func (o *CardPaymentMethodDetails) SetCardType(v string)

SetCardType sets field value

func (*CardPaymentMethodDetails) SetLastFourDigits 

func (o *CardPaymentMethodDetails) SetLastFourDigits(v string)

SetLastFourDigits sets field value

func (CardPaymentMethodDetails) ToMap 

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

func (*CardPaymentMethodDetails) UnmarshalJSON 

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

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"`
	XPoweredBy       string            `json:"xPoweredBy,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 {
	// The description detailing the cause of the error code.
	Message string `json:"message"`
	// Validation errors, if any.
	ValidationErrors     []string `json:"validationErrors,omitempty"`
	AdditionalProperties map[string]interface{}
}

Error struct for Error

func NewError 

func NewError(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) 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) GetValidationErrors 

func (o *Error) GetValidationErrors() []string

GetValidationErrors returns the ValidationErrors field value if set, zero value otherwise.

func (*Error) GetValidationErrorsOk 

func (o *Error) GetValidationErrorsOk() ([]string, bool)

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

func (*Error) HasValidationErrors 

func (o *Error) HasValidationErrors() bool

HasValidationErrors returns a boolean if a field has been set.

func (Error) MarshalJSON 

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

func (*Error) SetMessage 

func (o *Error) SetMessage(v string)

SetMessage sets field value

func (*Error) SetValidationErrors 

func (o *Error) SetValidationErrors(v []string)

SetValidationErrors gets a reference to the given []string and assigns it to the ValidationErrors field.

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 NullableCardPaymentMethodDetails 

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

func NewNullableCardPaymentMethodDetails 

func NewNullableCardPaymentMethodDetails(val *CardPaymentMethodDetails) *NullableCardPaymentMethodDetails

func (NullableCardPaymentMethodDetails) Get 

func (v NullableCardPaymentMethodDetails) Get() *CardPaymentMethodDetails

func (NullableCardPaymentMethodDetails) IsSet 

func (v NullableCardPaymentMethodDetails) IsSet() bool

func (NullableCardPaymentMethodDetails) MarshalJSON 

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

func (*NullableCardPaymentMethodDetails) Set 

func (v *NullableCardPaymentMethodDetails) Set(val *CardPaymentMethodDetails)

func (*NullableCardPaymentMethodDetails) UnmarshalJSON 

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

func (*NullableCardPaymentMethodDetails) Unset 

func (v *NullableCardPaymentMethodDetails) 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 NullablePaginatedResponse 

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

func NewNullablePaginatedResponse 

func NewNullablePaginatedResponse(val *PaginatedResponse) *NullablePaginatedResponse

func (NullablePaginatedResponse) Get 

func (v NullablePaginatedResponse) Get() *PaginatedResponse

func (NullablePaginatedResponse) IsSet 

func (v NullablePaginatedResponse) IsSet() bool

func (NullablePaginatedResponse) MarshalJSON 

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

func (*NullablePaginatedResponse) Set 

func (v *NullablePaginatedResponse) Set(val *PaginatedResponse)

func (*NullablePaginatedResponse) UnmarshalJSON 

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

func (*NullablePaginatedResponse) Unset 

func (v *NullablePaginatedResponse) Unset()

type NullablePaginatedTransactions 

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

func NewNullablePaginatedTransactions 

func NewNullablePaginatedTransactions(val *PaginatedTransactions) *NullablePaginatedTransactions

func (NullablePaginatedTransactions) Get 

func (v NullablePaginatedTransactions) Get() *PaginatedTransactions

func (NullablePaginatedTransactions) IsSet 

func (v NullablePaginatedTransactions) IsSet() bool

func (NullablePaginatedTransactions) MarshalJSON 

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

func (*NullablePaginatedTransactions) Set 

func (v *NullablePaginatedTransactions) Set(val *PaginatedTransactions)

func (*NullablePaginatedTransactions) UnmarshalJSON 

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

func (*NullablePaginatedTransactions) Unset 

func (v *NullablePaginatedTransactions) 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 NullableTransaction 

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

func NewNullableTransaction 

func NewNullableTransaction(val *Transaction) *NullableTransaction

func (NullableTransaction) Get 

func (v NullableTransaction) Get() *Transaction

func (NullableTransaction) IsSet 

func (v NullableTransaction) IsSet() bool

func (NullableTransaction) MarshalJSON 

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

func (*NullableTransaction) Set 

func (v *NullableTransaction) Set(val *Transaction)

func (*NullableTransaction) UnmarshalJSON 

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

func (*NullableTransaction) Unset 

func (v *NullableTransaction) Unset()

type NullableTransactionMetadata 

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

func NewNullableTransactionMetadata 

func NewNullableTransactionMetadata(val *TransactionMetadata) *NullableTransactionMetadata

func (NullableTransactionMetadata) Get 

func (v NullableTransactionMetadata) Get() *TransactionMetadata

func (NullableTransactionMetadata) IsSet 

func (v NullableTransactionMetadata) IsSet() bool

func (NullableTransactionMetadata) MarshalJSON 

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

func (*NullableTransactionMetadata) Set 

func (v *NullableTransactionMetadata) Set(val *TransactionMetadata)

func (*NullableTransactionMetadata) UnmarshalJSON 

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

func (*NullableTransactionMetadata) Unset 

func (v *NullableTransactionMetadata) Unset()

type PaginatedResponse 

type PaginatedResponse struct {
	// Maximum number of items in the page (actual returned length can be less).
	Limit int32 `json:"limit"`
	// The number of returned items skipped.
	Offset int32 `json:"offset"`
	// The total number of records available for retrieval.
	Total                int64 `json:"total"`
	AdditionalProperties map[string]interface{}
}

PaginatedResponse struct for PaginatedResponse

func NewPaginatedResponse 

func NewPaginatedResponse(limit int32, offset int32, total int64) *PaginatedResponse

NewPaginatedResponse instantiates a new PaginatedResponse 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 NewPaginatedResponseWithDefaults 

func NewPaginatedResponseWithDefaults() *PaginatedResponse

NewPaginatedResponseWithDefaults instantiates a new PaginatedResponse 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 (*PaginatedResponse) GetLimit 

func (o *PaginatedResponse) GetLimit() int32

GetLimit returns the Limit field value

func (*PaginatedResponse) GetLimitOk 

func (o *PaginatedResponse) GetLimitOk() (*int32, bool)

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

func (*PaginatedResponse) GetOffset 

func (o *PaginatedResponse) GetOffset() int32

GetOffset returns the Offset field value

func (*PaginatedResponse) GetOffsetOk 

func (o *PaginatedResponse) GetOffsetOk() (*int32, bool)

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

func (*PaginatedResponse) GetTotal 

func (o *PaginatedResponse) GetTotal() int64

GetTotal returns the Total field value

func (*PaginatedResponse) GetTotalOk 

func (o *PaginatedResponse) GetTotalOk() (*int64, bool)

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

func (PaginatedResponse) MarshalJSON 

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

func (*PaginatedResponse) SetLimit 

func (o *PaginatedResponse) SetLimit(v int32)

SetLimit sets field value

func (*PaginatedResponse) SetOffset 

func (o *PaginatedResponse) SetOffset(v int32)

SetOffset sets field value

func (*PaginatedResponse) SetTotal 

func (o *PaginatedResponse) SetTotal(v int64)

SetTotal sets field value

func (PaginatedResponse) ToMap 

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

func (*PaginatedResponse) UnmarshalJSON 

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

type PaginatedTransactions 

type PaginatedTransactions struct {
	// Maximum number of items in the page (actual returned length can be less).
	Limit int32 `json:"limit"`
	// The number of returned items skipped.
	Offset int32 `json:"offset"`
	// The total number of records available for retrieval.
	Total                int64         `json:"total"`
	Results              []Transaction `json:"results"`
	AdditionalProperties map[string]interface{}
}

PaginatedTransactions struct for PaginatedTransactions

func NewPaginatedTransactions 

func NewPaginatedTransactions(limit int32, offset int32, total int64, results []Transaction) *PaginatedTransactions

NewPaginatedTransactions instantiates a new PaginatedTransactions 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 NewPaginatedTransactionsWithDefaults 

func NewPaginatedTransactionsWithDefaults() *PaginatedTransactions

NewPaginatedTransactionsWithDefaults instantiates a new PaginatedTransactions 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 (*PaginatedTransactions) GetLimit 

func (o *PaginatedTransactions) GetLimit() int32

GetLimit returns the Limit field value

func (*PaginatedTransactions) GetLimitOk 

func (o *PaginatedTransactions) GetLimitOk() (*int32, bool)

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

func (*PaginatedTransactions) GetOffset 

func (o *PaginatedTransactions) GetOffset() int32

GetOffset returns the Offset field value

func (*PaginatedTransactions) GetOffsetOk 

func (o *PaginatedTransactions) GetOffsetOk() (*int32, bool)

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

func (*PaginatedTransactions) GetResults 

func (o *PaginatedTransactions) GetResults() []Transaction

GetResults returns the Results field value

func (*PaginatedTransactions) GetResultsOk 

func (o *PaginatedTransactions) GetResultsOk() ([]Transaction, bool)

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

func (*PaginatedTransactions) GetTotal 

func (o *PaginatedTransactions) GetTotal() int64

GetTotal returns the Total field value

func (*PaginatedTransactions) GetTotalOk 

func (o *PaginatedTransactions) GetTotalOk() (*int64, bool)

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

func (PaginatedTransactions) MarshalJSON 

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

func (*PaginatedTransactions) SetLimit 

func (o *PaginatedTransactions) SetLimit(v int32)

SetLimit sets field value

func (*PaginatedTransactions) SetOffset 

func (o *PaginatedTransactions) SetOffset(v int32)

SetOffset sets field value

func (*PaginatedTransactions) SetResults 

func (o *PaginatedTransactions) SetResults(v []Transaction)

SetResults sets field value

func (*PaginatedTransactions) SetTotal 

func (o *PaginatedTransactions) SetTotal(v int64)

SetTotal sets field value

func (PaginatedTransactions) ToMap 

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

func (*PaginatedTransactions) UnmarshalJSON 

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

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 Transaction 

type Transaction struct {
	// The Transaction ID.
	Id string `json:"id"`
	// The Transaction status. Status may be: SUCCESS, PROCESSING, FAILED
	Status string `json:"status"`
	// Details about the transaction. Contains failure reason in case of failed transactions.
	Details *string `json:"details,omitempty"`
	// The transaction amount.
	Amount float32 `json:"amount"`
	// The transaction currency.
	Currency string `json:"currency"`
	// Date and time when transaction was created.
	Date                     time.Time                `json:"date"`
	Metadata                 TransactionMetadata      `json:"metadata"`
	CardPaymentMethodDetails CardPaymentMethodDetails `json:"cardPaymentMethodDetails"`
	AdditionalProperties     map[string]interface{}
}

Transaction Transaction response model.

func NewTransaction 

func NewTransaction(id string, status string, amount float32, currency string, date time.Time, metadata TransactionMetadata, cardPaymentMethodDetails CardPaymentMethodDetails) *Transaction

NewTransaction instantiates a new Transaction 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 NewTransactionWithDefaults 

func NewTransactionWithDefaults() *Transaction

NewTransactionWithDefaults instantiates a new Transaction 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 (*Transaction) GetAmount 

func (o *Transaction) GetAmount() float32

GetAmount returns the Amount field value

func (*Transaction) GetAmountOk 

func (o *Transaction) GetAmountOk() (*float32, bool)

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

func (*Transaction) GetCardPaymentMethodDetails 

func (o *Transaction) GetCardPaymentMethodDetails() CardPaymentMethodDetails

GetCardPaymentMethodDetails returns the CardPaymentMethodDetails field value

func (*Transaction) GetCardPaymentMethodDetailsOk 

func (o *Transaction) GetCardPaymentMethodDetailsOk() (*CardPaymentMethodDetails, bool)

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

func (*Transaction) GetCurrency 

func (o *Transaction) GetCurrency() string

GetCurrency returns the Currency field value

func (*Transaction) GetCurrencyOk 

func (o *Transaction) GetCurrencyOk() (*string, bool)

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

func (*Transaction) GetDate 

func (o *Transaction) GetDate() time.Time

GetDate returns the Date field value

func (*Transaction) GetDateOk 

func (o *Transaction) GetDateOk() (*time.Time, bool)

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

func (*Transaction) GetDetails 

func (o *Transaction) GetDetails() string

GetDetails returns the Details field value if set, zero value otherwise.

func (*Transaction) GetDetailsOk 

func (o *Transaction) GetDetailsOk() (*string, bool)

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

func (*Transaction) GetId 

func (o *Transaction) GetId() string

GetId returns the Id field value

func (*Transaction) GetIdOk 

func (o *Transaction) GetIdOk() (*string, bool)

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

func (*Transaction) GetMetadata 

func (o *Transaction) GetMetadata() TransactionMetadata

GetMetadata returns the Metadata field value

func (*Transaction) GetMetadataOk 

func (o *Transaction) GetMetadataOk() (*TransactionMetadata, bool)

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

func (*Transaction) GetStatus 

func (o *Transaction) GetStatus() string

GetStatus returns the Status field value

func (*Transaction) GetStatusOk 

func (o *Transaction) GetStatusOk() (*string, bool)

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

func (*Transaction) HasDetails 

func (o *Transaction) HasDetails() bool

HasDetails returns a boolean if a field has been set.

func (Transaction) MarshalJSON 

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

func (*Transaction) SetAmount 

func (o *Transaction) SetAmount(v float32)

SetAmount sets field value

func (*Transaction) SetCardPaymentMethodDetails 

func (o *Transaction) SetCardPaymentMethodDetails(v CardPaymentMethodDetails)

SetCardPaymentMethodDetails sets field value

func (*Transaction) SetCurrency 

func (o *Transaction) SetCurrency(v string)

SetCurrency sets field value

func (*Transaction) SetDate 

func (o *Transaction) SetDate(v time.Time)

SetDate sets field value

func (*Transaction) SetDetails 

func (o *Transaction) SetDetails(v string)

SetDetails gets a reference to the given string and assigns it to the Details field.

func (*Transaction) SetId 

func (o *Transaction) SetId(v string)

SetId sets field value

func (*Transaction) SetMetadata 

func (o *Transaction) SetMetadata(v TransactionMetadata)

SetMetadata sets field value

func (*Transaction) SetStatus 

func (o *Transaction) SetStatus(v string)

SetStatus sets field value

func (Transaction) ToMap 

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

func (*Transaction) UnmarshalJSON 

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

type TransactionMetadata 

type TransactionMetadata struct {
	// The Invoice ID that this transaction pertains to.
	InvoiceId string `json:"invoiceId"`
	// A user-friendly reference number assigned to the invoice that this transaction pertains to.
	InvoiceNumber *string `json:"invoiceNumber,omitempty"`
	// Whether this transaction was triggered by an auto charge or not.
	IsAutoCharge         bool `json:"isAutoCharge"`
	AdditionalProperties map[string]interface{}
}

TransactionMetadata Transaction's metadata.

func NewTransactionMetadata 

func NewTransactionMetadata(invoiceId string, isAutoCharge bool) *TransactionMetadata

NewTransactionMetadata instantiates a new TransactionMetadata 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 NewTransactionMetadataWithDefaults 

func NewTransactionMetadataWithDefaults() *TransactionMetadata

NewTransactionMetadataWithDefaults instantiates a new TransactionMetadata 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 (*TransactionMetadata) GetInvoiceId 

func (o *TransactionMetadata) GetInvoiceId() string

GetInvoiceId returns the InvoiceId field value

func (*TransactionMetadata) GetInvoiceIdOk 

func (o *TransactionMetadata) GetInvoiceIdOk() (*string, bool)

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

func (*TransactionMetadata) GetInvoiceNumber 

func (o *TransactionMetadata) GetInvoiceNumber() string

GetInvoiceNumber returns the InvoiceNumber field value if set, zero value otherwise.

func (*TransactionMetadata) GetInvoiceNumberOk 

func (o *TransactionMetadata) GetInvoiceNumberOk() (*string, bool)

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

func (*TransactionMetadata) GetIsAutoCharge 

func (o *TransactionMetadata) GetIsAutoCharge() bool

GetIsAutoCharge returns the IsAutoCharge field value

func (*TransactionMetadata) GetIsAutoChargeOk 

func (o *TransactionMetadata) GetIsAutoChargeOk() (*bool, bool)

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

func (*TransactionMetadata) HasInvoiceNumber 

func (o *TransactionMetadata) HasInvoiceNumber() bool

HasInvoiceNumber returns a boolean if a field has been set.

func (TransactionMetadata) MarshalJSON 

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

func (*TransactionMetadata) SetInvoiceId 

func (o *TransactionMetadata) SetInvoiceId(v string)

SetInvoiceId sets field value

func (*TransactionMetadata) SetInvoiceNumber 

func (o *TransactionMetadata) SetInvoiceNumber(v string)

SetInvoiceNumber gets a reference to the given string and assigns it to the InvoiceNumber field.

func (*TransactionMetadata) SetIsAutoCharge 

func (o *TransactionMetadata) SetIsAutoCharge(v bool)

SetIsAutoCharge sets field value

func (TransactionMetadata) ToMap 

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

func (*TransactionMetadata) UnmarshalJSON 

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

type TransactionsAPI 

type TransactionsAPI interface {

	/*
		TransactionIdGet Get Transaction.

		Get transaction details.

		@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		@param transactionId The transaction identifier.
		@return ApiTransactionIdGetRequest
	*/
	TransactionIdGet(ctx context.Context, transactionId string) ApiTransactionIdGetRequest

	// TransactionIdGetExecute executes the request
	//  @return Transaction
	TransactionIdGetExecute(r ApiTransactionIdGetRequest) (*Transaction, *http.Response, error)

	/*
		TransactionsGet Get Transactions.

		A paginated list of client's transactions.

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

	// TransactionsGetExecute executes the request
	//  @return PaginatedTransactions
	TransactionsGetExecute(r ApiTransactionsGetRequest) (*PaginatedTransactions, *http.Response, error)
}

type TransactionsAPIService 

type TransactionsAPIService service

TransactionsAPIService TransactionsAPI service

func (*TransactionsAPIService) TransactionIdGet 

func (a *TransactionsAPIService) TransactionIdGet(ctx context.Context, transactionId string) ApiTransactionIdGetRequest

TransactionIdGet Get Transaction.

Get transaction details. 

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

func (*TransactionsAPIService) TransactionIdGetExecute 

func (a *TransactionsAPIService) TransactionIdGetExecute(r ApiTransactionIdGetRequest) (*Transaction, *http.Response, error)

Execute executes the request 

@return Transaction

func (*TransactionsAPIService) TransactionsGet 

func (a *TransactionsAPIService) TransactionsGet(ctx context.Context) ApiTransactionsGetRequest

TransactionsGet Get Transactions.

A paginated list of client's transactions. 

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

func (*TransactionsAPIService) TransactionsGetExecute 

func (a *TransactionsAPIService) TransactionsGetExecute(r ApiTransactionsGetRequest) (*PaginatedTransactions, *http.Response, error)

Execute executes the request 

@return PaginatedTransactions

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.