agreementmanagement

package module
v0.3.1 Latest Latest
Warning

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

 Go to latest Published: Jan 12, 2024 License: BSD-3-Clause Imports: 19 Imported by: 0

README

Go API client for agreementmanagement

The PingOne Platform API covering the PingOne Agreement Management service

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: 2023-06-29
  • Package version: 0.3.1
  • 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 agreementmanagement "github.com/patrickcping/pingone-go-sdk-v2/agreementmanagement"

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

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

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

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

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

Documentation for API Endpoints

All URIs are relative to https://agreement-mgmt.pingone.com

Class Method HTTP request Description
AgreementRevisionsResourcesApi ReadOneAgreementLanguageRevision Get /environments/{environmentID}/agreements/{agreementID}/languages/{languageID}/revisions/{revisionID}.json READ One Agreement Language Revision

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearer
  • Type: HTTP Bearer token authentication

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "BEARER_TOKEN_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 (
	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

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

APIClient manages communication with the PingOne Platform API - Agreement Management API v2022-09-23 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 AgreementRevisionText 

type AgreementRevisionText struct {
	ResourcePath *string `json:"resourcePath,omitempty"`
	Data         *string `json:"data,omitempty"`
	DataType     *string `json:"dataType,omitempty"`
}

AgreementRevisionText struct for AgreementRevisionText

func NewAgreementRevisionText 

func NewAgreementRevisionText() *AgreementRevisionText

NewAgreementRevisionText instantiates a new AgreementRevisionText 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 NewAgreementRevisionTextWithDefaults 

func NewAgreementRevisionTextWithDefaults() *AgreementRevisionText

NewAgreementRevisionTextWithDefaults instantiates a new AgreementRevisionText 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 (*AgreementRevisionText) GetData 

func (o *AgreementRevisionText) GetData() string

GetData returns the Data field value if set, zero value otherwise.

func (*AgreementRevisionText) GetDataOk 

func (o *AgreementRevisionText) GetDataOk() (*string, bool)

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

func (*AgreementRevisionText) GetDataType 

func (o *AgreementRevisionText) GetDataType() string

GetDataType returns the DataType field value if set, zero value otherwise.

func (*AgreementRevisionText) GetDataTypeOk 

func (o *AgreementRevisionText) GetDataTypeOk() (*string, bool)

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

func (*AgreementRevisionText) GetResourcePath 

func (o *AgreementRevisionText) GetResourcePath() string

GetResourcePath returns the ResourcePath field value if set, zero value otherwise.

func (*AgreementRevisionText) GetResourcePathOk 

func (o *AgreementRevisionText) GetResourcePathOk() (*string, bool)

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

func (*AgreementRevisionText) HasData 

func (o *AgreementRevisionText) HasData() bool

HasData returns a boolean if a field has been set.

func (*AgreementRevisionText) HasDataType 

func (o *AgreementRevisionText) HasDataType() bool

HasDataType returns a boolean if a field has been set.

func (*AgreementRevisionText) HasResourcePath 

func (o *AgreementRevisionText) HasResourcePath() bool

HasResourcePath returns a boolean if a field has been set.

func (AgreementRevisionText) MarshalJSON 

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

func (*AgreementRevisionText) SetData 

func (o *AgreementRevisionText) SetData(v string)

SetData gets a reference to the given string and assigns it to the Data field.

func (*AgreementRevisionText) SetDataType 

func (o *AgreementRevisionText) SetDataType(v string)

SetDataType gets a reference to the given string and assigns it to the DataType field.

func (*AgreementRevisionText) SetResourcePath 

func (o *AgreementRevisionText) SetResourcePath(v string)

SetResourcePath gets a reference to the given string and assigns it to the ResourcePath field.

func (AgreementRevisionText) ToMap 

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

type AgreementRevisionsResourcesApiService 

type AgreementRevisionsResourcesApiService service

AgreementRevisionsResourcesApiService AgreementRevisionsResourcesApi service

func (*AgreementRevisionsResourcesApiService) ReadOneAgreementLanguageRevision 

func (a *AgreementRevisionsResourcesApiService) ReadOneAgreementLanguageRevision(ctx context.Context, environmentID string, agreementID string, languageID string, revisionID string) ApiReadOneAgreementLanguageRevisionRequest

ReadOneAgreementLanguageRevision READ One Agreement Language Revision 

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

func (*AgreementRevisionsResourcesApiService) ReadOneAgreementLanguageRevisionExecute 

func (a *AgreementRevisionsResourcesApiService) ReadOneAgreementLanguageRevisionExecute(r ApiReadOneAgreementLanguageRevisionRequest) (*AgreementRevisionText, *http.Response, error)

Execute executes the request 

@return AgreementRevisionText

type ApiReadOneAgreementLanguageRevisionRequest 

type ApiReadOneAgreementLanguageRevisionRequest struct {
	ApiService *AgreementRevisionsResourcesApiService
	// contains filtered or unexported fields
}

func (ApiReadOneAgreementLanguageRevisionRequest) Execute 

func (r ApiReadOneAgreementLanguageRevisionRequest) Execute() (*AgreementRevisionText, *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"`
	DefaultServerIndex int               `json:"defaultServerIndex,omitempty"`
	ProxyURL           *string           `json:"proxyURL,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) AppendUserAgent added in v0.3.1 

func (c *Configuration) AppendUserAgent(userAgent string)

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

func (*Configuration) SetDebug added in v0.2.0 

func (c *Configuration) SetDebug(debug bool)

func (*Configuration) SetDefaultServerIndex added in v0.2.0 

func (c *Configuration) SetDefaultServerIndex(defaultServerIndex int)

func (*Configuration) SetDefaultServerVariableDefaultValue added in v0.2.0 

func (c *Configuration) SetDefaultServerVariableDefaultValue(variable string, value string) error

func (*Configuration) SetServerVariableDefaultValue added in v0.2.0 

func (c *Configuration) SetServerVariableDefaultValue(serverIndex int, variable string, value string) error

func (*Configuration) SetUserAgent added in v0.2.1 

func (c *Configuration) SetUserAgent(userAgent string)

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 NullableAgreementRevisionText 

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

func NewNullableAgreementRevisionText 

func NewNullableAgreementRevisionText(val *AgreementRevisionText) *NullableAgreementRevisionText

func (NullableAgreementRevisionText) Get 

func (v NullableAgreementRevisionText) Get() *AgreementRevisionText

func (NullableAgreementRevisionText) IsSet 

func (v NullableAgreementRevisionText) IsSet() bool

func (NullableAgreementRevisionText) MarshalJSON 

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

func (*NullableAgreementRevisionText) Set 

func (v *NullableAgreementRevisionText) Set(val *AgreementRevisionText)

func (*NullableAgreementRevisionText) UnmarshalJSON 

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

func (*NullableAgreementRevisionText) Unset 

func (v *NullableAgreementRevisionText) Unset()

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

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

func NewNullableP1Error 

func NewNullableP1Error(val *P1Error) *NullableP1Error

func (NullableP1Error) Get 

func (v NullableP1Error) Get() *P1Error

func (NullableP1Error) IsSet 

func (v NullableP1Error) IsSet() bool

func (NullableP1Error) MarshalJSON 

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

func (*NullableP1Error) Set 

func (v *NullableP1Error) Set(val *P1Error)

func (*NullableP1Error) UnmarshalJSON 

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

func (*NullableP1Error) Unset 

func (v *NullableP1Error) Unset()

type NullableP1ErrorDetailsInner 

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

func NewNullableP1ErrorDetailsInner 

func NewNullableP1ErrorDetailsInner(val *P1ErrorDetailsInner) *NullableP1ErrorDetailsInner

func (NullableP1ErrorDetailsInner) Get 

func (v NullableP1ErrorDetailsInner) Get() *P1ErrorDetailsInner

func (NullableP1ErrorDetailsInner) IsSet 

func (v NullableP1ErrorDetailsInner) IsSet() bool

func (NullableP1ErrorDetailsInner) MarshalJSON 

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

func (*NullableP1ErrorDetailsInner) Set 

func (v *NullableP1ErrorDetailsInner) Set(val *P1ErrorDetailsInner)

func (*NullableP1ErrorDetailsInner) UnmarshalJSON 

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

func (*NullableP1ErrorDetailsInner) Unset 

func (v *NullableP1ErrorDetailsInner) Unset()

type NullableP1ErrorDetailsInnerInnerError 

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

func NewNullableP1ErrorDetailsInnerInnerError 

func NewNullableP1ErrorDetailsInnerInnerError(val *P1ErrorDetailsInnerInnerError) *NullableP1ErrorDetailsInnerInnerError

func (NullableP1ErrorDetailsInnerInnerError) Get 

func (v NullableP1ErrorDetailsInnerInnerError) Get() *P1ErrorDetailsInnerInnerError

func (NullableP1ErrorDetailsInnerInnerError) IsSet 

func (v NullableP1ErrorDetailsInnerInnerError) IsSet() bool

func (NullableP1ErrorDetailsInnerInnerError) MarshalJSON 

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

func (*NullableP1ErrorDetailsInnerInnerError) Set 

func (v *NullableP1ErrorDetailsInnerInnerError) Set(val *P1ErrorDetailsInnerInnerError)

func (*NullableP1ErrorDetailsInnerInnerError) UnmarshalJSON 

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

func (*NullableP1ErrorDetailsInnerInnerError) Unset 

func (v *NullableP1ErrorDetailsInnerInnerError) 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 P1Error 

type P1Error struct {
	// A unique identifier that is stored in log files and always included in an error response. This value can be used to track the error received by the client, with server-side activity included for troubleshooting purposes.
	Id *string `json:"id,omitempty"`
	// A general fault code which the client must handle to provide all exception handling routines and to localize messages for users. This code is common across all PingOne services and is human readable (such as a defined constant rather than a number).
	Code *string `json:"code,omitempty"`
	// A short description of the error. This message is intended to assist with debugging and is returned in English only.
	Message *string `json:"message,omitempty"`
	// Additional details about the error. Optional information to help resolve the error and to display to users.
	Details []P1ErrorDetailsInner `json:"details,omitempty"`
}

P1Error struct for P1Error

func NewP1Error 

func NewP1Error() *P1Error

NewP1Error instantiates a new P1Error 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 NewP1ErrorWithDefaults 

func NewP1ErrorWithDefaults() *P1Error

NewP1ErrorWithDefaults instantiates a new P1Error 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 (*P1Error) GetCode 

func (o *P1Error) GetCode() string

GetCode returns the Code field value if set, zero value otherwise.

func (*P1Error) GetCodeOk 

func (o *P1Error) GetCodeOk() (*string, bool)

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

func (*P1Error) GetDetails 

func (o *P1Error) GetDetails() []P1ErrorDetailsInner

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

func (*P1Error) GetDetailsOk 

func (o *P1Error) GetDetailsOk() ([]P1ErrorDetailsInner, 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 (*P1Error) GetId 

func (o *P1Error) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*P1Error) GetIdOk 

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

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

func (*P1Error) GetMessage 

func (o *P1Error) GetMessage() string

GetMessage returns the Message field value if set, zero value otherwise.

func (*P1Error) GetMessageOk 

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

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

func (*P1Error) HasCode 

func (o *P1Error) HasCode() bool

HasCode returns a boolean if a field has been set.

func (*P1Error) HasDetails 

func (o *P1Error) HasDetails() bool

HasDetails returns a boolean if a field has been set.

func (*P1Error) HasId 

func (o *P1Error) HasId() bool

HasId returns a boolean if a field has been set.

func (*P1Error) HasMessage 

func (o *P1Error) HasMessage() bool

HasMessage returns a boolean if a field has been set.

func (P1Error) MarshalJSON 

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

func (*P1Error) SetCode 

func (o *P1Error) SetCode(v string)

SetCode gets a reference to the given string and assigns it to the Code field.

func (*P1Error) SetDetails 

func (o *P1Error) SetDetails(v []P1ErrorDetailsInner)

SetDetails gets a reference to the given []P1ErrorDetailsInner and assigns it to the Details field.

func (*P1Error) SetId 

func (o *P1Error) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*P1Error) SetMessage 

func (o *P1Error) SetMessage(v string)

SetMessage gets a reference to the given string and assigns it to the Message field.

func (P1Error) ToMap 

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

type P1ErrorDetailsInner 

type P1ErrorDetailsInner struct {
	// A general fault code which the client must handle to provide all exception handling routines and to localize messages for users. This code is common across all PingOne services and is human readable (such as a defined constant rather than a number).
	Code *string `json:"code,omitempty"`
	// The item that caused the error (such as a form field ID or an attribute inside a JSON object).
	Target *string `json:"target,omitempty"`
	// A short description of the error. This message is intended to assist with debugging and is returned in English only.
	Message    *string                        `json:"message,omitempty"`
	InnerError *P1ErrorDetailsInnerInnerError `json:"innerError,omitempty"`
}

P1ErrorDetailsInner struct for P1ErrorDetailsInner

func NewP1ErrorDetailsInner 

func NewP1ErrorDetailsInner() *P1ErrorDetailsInner

NewP1ErrorDetailsInner instantiates a new P1ErrorDetailsInner 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 NewP1ErrorDetailsInnerWithDefaults 

func NewP1ErrorDetailsInnerWithDefaults() *P1ErrorDetailsInner

NewP1ErrorDetailsInnerWithDefaults instantiates a new P1ErrorDetailsInner 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 (*P1ErrorDetailsInner) GetCode 

func (o *P1ErrorDetailsInner) GetCode() string

GetCode returns the Code field value if set, zero value otherwise.

func (*P1ErrorDetailsInner) GetCodeOk 

func (o *P1ErrorDetailsInner) GetCodeOk() (*string, bool)

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

func (*P1ErrorDetailsInner) GetInnerError 

func (o *P1ErrorDetailsInner) GetInnerError() P1ErrorDetailsInnerInnerError

GetInnerError returns the InnerError field value if set, zero value otherwise.

func (*P1ErrorDetailsInner) GetInnerErrorOk 

func (o *P1ErrorDetailsInner) GetInnerErrorOk() (*P1ErrorDetailsInnerInnerError, bool)

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

func (*P1ErrorDetailsInner) GetMessage 

func (o *P1ErrorDetailsInner) GetMessage() string

GetMessage returns the Message field value if set, zero value otherwise.

func (*P1ErrorDetailsInner) GetMessageOk 

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

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

func (*P1ErrorDetailsInner) GetTarget 

func (o *P1ErrorDetailsInner) GetTarget() string

GetTarget returns the Target field value if set, zero value otherwise.

func (*P1ErrorDetailsInner) GetTargetOk 

func (o *P1ErrorDetailsInner) GetTargetOk() (*string, bool)

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

func (*P1ErrorDetailsInner) HasCode 

func (o *P1ErrorDetailsInner) HasCode() bool

HasCode returns a boolean if a field has been set.

func (*P1ErrorDetailsInner) HasInnerError 

func (o *P1ErrorDetailsInner) HasInnerError() bool

HasInnerError returns a boolean if a field has been set.

func (*P1ErrorDetailsInner) HasMessage 

func (o *P1ErrorDetailsInner) HasMessage() bool

HasMessage returns a boolean if a field has been set.

func (*P1ErrorDetailsInner) HasTarget 

func (o *P1ErrorDetailsInner) HasTarget() bool

HasTarget returns a boolean if a field has been set.

func (P1ErrorDetailsInner) MarshalJSON 

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

func (*P1ErrorDetailsInner) SetCode 

func (o *P1ErrorDetailsInner) SetCode(v string)

SetCode gets a reference to the given string and assigns it to the Code field.

func (*P1ErrorDetailsInner) SetInnerError 

func (o *P1ErrorDetailsInner) SetInnerError(v P1ErrorDetailsInnerInnerError)

SetInnerError gets a reference to the given P1ErrorDetailsInnerInnerError and assigns it to the InnerError field.

func (*P1ErrorDetailsInner) SetMessage 

func (o *P1ErrorDetailsInner) SetMessage(v string)

SetMessage gets a reference to the given string and assigns it to the Message field.

func (*P1ErrorDetailsInner) SetTarget 

func (o *P1ErrorDetailsInner) SetTarget(v string)

SetTarget gets a reference to the given string and assigns it to the Target field.

func (P1ErrorDetailsInner) ToMap 

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

type P1ErrorDetailsInnerInnerError 

type P1ErrorDetailsInnerInnerError struct {
	// Errors that failed due to range violation. This attribute represents the minimum value of the range.
	RangeMinimumValue *int32 `json:"rangeMinimumValue,omitempty"`
	// The maximum range or value of an attribute.
	RangeMaximumValue *int32 `json:"rangeMaximumValue,omitempty"`
	// A regex pattern describing an acceptable input pattern.
	AllowedPattern *string `json:"allowedPattern,omitempty"`
	// A list describing acceptable values.
	AllowedValues []string `json:"allowedValues,omitempty"`
	// The maximum value allowed for the request.
	MaximumValue     *int32   `json:"maximumValue,omitempty"`
	ReferencedValues []string `json:"referencedValues,omitempty"`
}

P1ErrorDetailsInnerInnerError Additional details to help the client developer resolve the fault (primarily for UI validation reasons).

func NewP1ErrorDetailsInnerInnerError 

func NewP1ErrorDetailsInnerInnerError() *P1ErrorDetailsInnerInnerError

NewP1ErrorDetailsInnerInnerError instantiates a new P1ErrorDetailsInnerInnerError 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 NewP1ErrorDetailsInnerInnerErrorWithDefaults 

func NewP1ErrorDetailsInnerInnerErrorWithDefaults() *P1ErrorDetailsInnerInnerError

NewP1ErrorDetailsInnerInnerErrorWithDefaults instantiates a new P1ErrorDetailsInnerInnerError 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 (*P1ErrorDetailsInnerInnerError) GetAllowedPattern 

func (o *P1ErrorDetailsInnerInnerError) GetAllowedPattern() string

GetAllowedPattern returns the AllowedPattern field value if set, zero value otherwise.

func (*P1ErrorDetailsInnerInnerError) GetAllowedPatternOk 

func (o *P1ErrorDetailsInnerInnerError) GetAllowedPatternOk() (*string, bool)

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

func (*P1ErrorDetailsInnerInnerError) GetAllowedValues 

func (o *P1ErrorDetailsInnerInnerError) GetAllowedValues() []string

GetAllowedValues returns the AllowedValues field value if set, zero value otherwise.

func (*P1ErrorDetailsInnerInnerError) GetAllowedValuesOk 

func (o *P1ErrorDetailsInnerInnerError) GetAllowedValuesOk() ([]string, bool)

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

func (*P1ErrorDetailsInnerInnerError) GetMaximumValue 

func (o *P1ErrorDetailsInnerInnerError) GetMaximumValue() int32

GetMaximumValue returns the MaximumValue field value if set, zero value otherwise.

func (*P1ErrorDetailsInnerInnerError) GetMaximumValueOk 

func (o *P1ErrorDetailsInnerInnerError) GetMaximumValueOk() (*int32, bool)

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

func (*P1ErrorDetailsInnerInnerError) GetRangeMaximumValue 

func (o *P1ErrorDetailsInnerInnerError) GetRangeMaximumValue() int32

GetRangeMaximumValue returns the RangeMaximumValue field value if set, zero value otherwise.

func (*P1ErrorDetailsInnerInnerError) GetRangeMaximumValueOk 

func (o *P1ErrorDetailsInnerInnerError) GetRangeMaximumValueOk() (*int32, bool)

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

func (*P1ErrorDetailsInnerInnerError) GetRangeMinimumValue 

func (o *P1ErrorDetailsInnerInnerError) GetRangeMinimumValue() int32

GetRangeMinimumValue returns the RangeMinimumValue field value if set, zero value otherwise.

func (*P1ErrorDetailsInnerInnerError) GetRangeMinimumValueOk 

func (o *P1ErrorDetailsInnerInnerError) GetRangeMinimumValueOk() (*int32, bool)

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

func (*P1ErrorDetailsInnerInnerError) GetReferencedValues added in v0.3.0 

func (o *P1ErrorDetailsInnerInnerError) GetReferencedValues() []string

GetReferencedValues returns the ReferencedValues field value if set, zero value otherwise.

func (*P1ErrorDetailsInnerInnerError) GetReferencedValuesOk added in v0.3.0 

func (o *P1ErrorDetailsInnerInnerError) GetReferencedValuesOk() ([]string, bool)

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

func (*P1ErrorDetailsInnerInnerError) HasAllowedPattern 

func (o *P1ErrorDetailsInnerInnerError) HasAllowedPattern() bool

HasAllowedPattern returns a boolean if a field has been set.

func (*P1ErrorDetailsInnerInnerError) HasAllowedValues 

func (o *P1ErrorDetailsInnerInnerError) HasAllowedValues() bool

HasAllowedValues returns a boolean if a field has been set.

func (*P1ErrorDetailsInnerInnerError) HasMaximumValue 

func (o *P1ErrorDetailsInnerInnerError) HasMaximumValue() bool

HasMaximumValue returns a boolean if a field has been set.

func (*P1ErrorDetailsInnerInnerError) HasRangeMaximumValue 

func (o *P1ErrorDetailsInnerInnerError) HasRangeMaximumValue() bool

HasRangeMaximumValue returns a boolean if a field has been set.

func (*P1ErrorDetailsInnerInnerError) HasRangeMinimumValue 

func (o *P1ErrorDetailsInnerInnerError) HasRangeMinimumValue() bool

HasRangeMinimumValue returns a boolean if a field has been set.

func (*P1ErrorDetailsInnerInnerError) HasReferencedValues added in v0.3.0 

func (o *P1ErrorDetailsInnerInnerError) HasReferencedValues() bool

HasReferencedValues returns a boolean if a field has been set.

func (P1ErrorDetailsInnerInnerError) MarshalJSON 

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

func (*P1ErrorDetailsInnerInnerError) SetAllowedPattern 

func (o *P1ErrorDetailsInnerInnerError) SetAllowedPattern(v string)

SetAllowedPattern gets a reference to the given string and assigns it to the AllowedPattern field.

func (*P1ErrorDetailsInnerInnerError) SetAllowedValues 

func (o *P1ErrorDetailsInnerInnerError) SetAllowedValues(v []string)

SetAllowedValues gets a reference to the given []string and assigns it to the AllowedValues field.

func (*P1ErrorDetailsInnerInnerError) SetMaximumValue 

func (o *P1ErrorDetailsInnerInnerError) SetMaximumValue(v int32)

SetMaximumValue gets a reference to the given int32 and assigns it to the MaximumValue field.

func (*P1ErrorDetailsInnerInnerError) SetRangeMaximumValue 

func (o *P1ErrorDetailsInnerInnerError) SetRangeMaximumValue(v int32)

SetRangeMaximumValue gets a reference to the given int32 and assigns it to the RangeMaximumValue field.

func (*P1ErrorDetailsInnerInnerError) SetRangeMinimumValue 

func (o *P1ErrorDetailsInnerInnerError) SetRangeMinimumValue(v int32)

SetRangeMinimumValue gets a reference to the given int32 and assigns it to the RangeMinimumValue field.

func (*P1ErrorDetailsInnerInnerError) SetReferencedValues added in v0.3.0 

func (o *P1ErrorDetailsInnerInnerError) SetReferencedValues(v []string)

SetReferencedValues gets a reference to the given []string and assigns it to the ReferencedValues field.

func (P1ErrorDetailsInnerInnerError) ToMap 

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

type SDKInterfaceFunc added in v0.1.2 

type SDKInterfaceFunc func() (any, *http.Response, 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

Source Files

View all Source files

Directories

Path Synopsis
generate
postprocessing

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.