api

package module
v0.0.0-...-48b9d42 Latest Latest
Warning

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

 Go to latest Published: Dec 18, 2023 License: Apache-2.0 Imports: 22 Imported by: 1

README

Go API client for api

Welcome to the Configurator HTTP API documentation. You will find documentation for all HTTP APIs here.

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

Installation

Install the following dependencies:

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

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

import api "github.com/gunsluo/go-example/openapi/client/api"

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(), api.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(), api.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 identifield 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(), api.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), api.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
OrganizationApi AddMembersRequest Post /org/add-members Add members to the organization

Documentation For Models

Documentation For Authorization

Bearer
  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

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

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

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

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKeys takes a string apikey as authentication for the request
	ContextAPIKeys = contextKey("apiKeys")

	// ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request.
	ContextHttpSignatureAuth = contextKey("httpsignature")

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

APIClient manages communication with the Configurator API vlatest 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 APIResonse object.

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

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

type AddMembersResponse 

type AddMembersResponse struct {
	Data AddMembersResponseData `json:"data"`
}

AddMembersResponse struct for AddMembersResponse

func NewAddMembersResponse 

func NewAddMembersResponse(data AddMembersResponseData) *AddMembersResponse

NewAddMembersResponse instantiates a new AddMembersResponse 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 NewAddMembersResponseWithDefaults 

func NewAddMembersResponseWithDefaults() *AddMembersResponse

NewAddMembersResponseWithDefaults instantiates a new AddMembersResponse 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 (*AddMembersResponse) GetData 

func (o *AddMembersResponse) GetData() AddMembersResponseData

GetData returns the Data field value

func (*AddMembersResponse) GetDataOk 

func (o *AddMembersResponse) GetDataOk() (*AddMembersResponseData, bool)

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

func (AddMembersResponse) MarshalJSON 

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

func (*AddMembersResponse) SetData 

func (o *AddMembersResponse) SetData(v AddMembersResponseData)

SetData sets field value

type AddMembersResponseData 

type AddMembersResponseData struct {
	Created                  []string `json:"created,omitempty"`
	EmailAlreadyExists       []string `json:"email_already_exists,omitempty"`
	PhoneMobileAlreadyExists []string `json:"phone_mobile_already_exists,omitempty"`
}

AddMembersResponseData struct for AddMembersResponseData

func NewAddMembersResponseData 

func NewAddMembersResponseData() *AddMembersResponseData

NewAddMembersResponseData instantiates a new AddMembersResponseData 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 NewAddMembersResponseDataWithDefaults 

func NewAddMembersResponseDataWithDefaults() *AddMembersResponseData

NewAddMembersResponseDataWithDefaults instantiates a new AddMembersResponseData 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 (*AddMembersResponseData) GetCreated 

func (o *AddMembersResponseData) GetCreated() []string

GetCreated returns the Created field value if set, zero value otherwise.

func (*AddMembersResponseData) GetCreatedOk 

func (o *AddMembersResponseData) GetCreatedOk() ([]string, bool)

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

func (*AddMembersResponseData) GetEmailAlreadyExists 

func (o *AddMembersResponseData) GetEmailAlreadyExists() []string

GetEmailAlreadyExists returns the EmailAlreadyExists field value if set, zero value otherwise.

func (*AddMembersResponseData) GetEmailAlreadyExistsOk 

func (o *AddMembersResponseData) GetEmailAlreadyExistsOk() ([]string, bool)

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

func (*AddMembersResponseData) GetPhoneMobileAlreadyExists 

func (o *AddMembersResponseData) GetPhoneMobileAlreadyExists() []string

GetPhoneMobileAlreadyExists returns the PhoneMobileAlreadyExists field value if set, zero value otherwise.

func (*AddMembersResponseData) GetPhoneMobileAlreadyExistsOk 

func (o *AddMembersResponseData) GetPhoneMobileAlreadyExistsOk() ([]string, bool)

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

func (*AddMembersResponseData) HasCreated 

func (o *AddMembersResponseData) HasCreated() bool

HasCreated returns a boolean if a field has been set.

func (*AddMembersResponseData) HasEmailAlreadyExists 

func (o *AddMembersResponseData) HasEmailAlreadyExists() bool

HasEmailAlreadyExists returns a boolean if a field has been set.

func (*AddMembersResponseData) HasPhoneMobileAlreadyExists 

func (o *AddMembersResponseData) HasPhoneMobileAlreadyExists() bool

HasPhoneMobileAlreadyExists returns a boolean if a field has been set.

func (AddMembersResponseData) MarshalJSON 

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

func (*AddMembersResponseData) SetCreated 

func (o *AddMembersResponseData) SetCreated(v []string)

SetCreated gets a reference to the given []string and assigns it to the Created field.

func (*AddMembersResponseData) SetEmailAlreadyExists 

func (o *AddMembersResponseData) SetEmailAlreadyExists(v []string)

SetEmailAlreadyExists gets a reference to the given []string and assigns it to the EmailAlreadyExists field.

func (*AddMembersResponseData) SetPhoneMobileAlreadyExists 

func (o *AddMembersResponseData) SetPhoneMobileAlreadyExists(v []string)

SetPhoneMobileAlreadyExists gets a reference to the given []string and assigns it to the PhoneMobileAlreadyExists field.

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

type JsonErrorResponse struct {
	// Code responses is error code when an error occurred.  Success                       Code = \"Success\" BadRequest                    Code = \"BadRequest\" InvalidOrganizationID         Code = \"InvalidOrganizationID\" InvalidOrganization           Code = \"InvalidOrganization\" InvalidOrgUser                Code = \"InvalidOrgUser\" EmptyOrgUserList              Code = \"EmptyOrgUserList\" FailedToDeleteOrg             Code = \"FailedToDeleteOrg\" FailedToAddSubsidiary         Code = \"FailedToAddSubsidiary\" InvalidUserInfo               Code = \"InvalidUserInfo\" InvalidUserProfile            Code = \"InvalidUserProfile\" GrpcConnectionFailed          Code = \"GrpcConnectionFailed\" InvalidCrtOrKey               Code = \"InvalidCrtOrKey\" Forbidden                     Code = \"Forbidden\" FailedToPostFile              Code = \"FailedToPostFile\" FileCantParsed                Code = \"FileCantParsed\" SheetNotFound                 Code = \"SheetNotFound\" DataError                     Code = \"DataError\" OrgUserDataEmpty              Code = \"OrgUserDataEmpty\" TemplateError                 Code = \"TemplateError\" MemberLimit100                Code = \"MemberLimit100\" EmptyEmailAddress             Code = \"EmptyEmailAddress\" InvalidEmailFormat            Code = \"InvalidEmailFormat\" InvalidPassword               Code = \"InvalidPassword\" InvalidCompany                Code = \"InvalidCompany\" InvalidFeature                Code = \"InvalidFeature\" InvalidFeatureDefaultRole     Code = \"InvalidFeatureDefaultRole\" InvalidApp                    Code = \"InvalidApp\" InvalidSubOrder               Code = \"InvalidSubOrder\" InvalidAppRole                Code = \"InvalidAppRole\" InvalidPlan                   Code = \"InvalidPlan\" InvalidSubscription           Code = \"InvalidSubscription\" InvalidOrganisationConfigs    Code = \"InvalidOrganisationConfigs\" InvalidPpPRelation            Code = \"InvalidPpPRelation\" InvalidPrePolicy              Code = \"InvalidPrePolicy\" InvalidPhoneNumber            Code = \"InvalidPhoneNumber\" InvalidContactPerson          Code = \"InvalidContactPerson\" InvalidCountry                Code = \"InvalidCountry\" DuplicatedEmailAddress        Code = \"DuplicatedEmailAddress\" DuplicatedMember              Code = \"DuplicatedMember\" EmptyMemberName               Code = \"EmptyMemberName\" TheEmailAddressAlreadyExists  Code = \"TheEmailAddressAlreadyExists\" NotMatchedWithEmail           Code = \"NotMatchedWithEmail\" MaxMemberLimitError           Code = \"MaxMemberLimitError\" DataValidationError           Code = \"DataValidationError\" FailedToCreateUser            Code = \"FailedToCreateUser\" FailedToCreateSubOrder        Code = \"FailedToCreateSubscriptionOrder\" FailedToCreateOrganizationApp Code = \"FailedToCreateOrganizationApp\" FailedToAddUserToFreePlan     Code = \"FailedToAddUserToFreePlan\" FailedToAddUserToAdmin        Code = \"FailedToAddUserToAdmin\" FailedToAddSubscription       Code = \"FailedToAddSubscription\" FailedToCreateUserTags        Code = \"FailedToCreateUserTags\" FailedToExecuteCallback       Code = \"FailedToExecuteCallback\" FailedToSyncOrg               Code = \"FailedToSyncOrg\" FailedToGetCompany            Code = \"FailedToGetCompany\" FailedToSyncOrgApp            Code = \"FailedToSyncOrgApp\" NotTheCreator                 Code = \"NotTheCreator\" FailedToConvertPolicy         Code = \"FailedToConvertPolicy\" FailedToSyncPolicy            Code = \"FailedToSyncPolicy\" FailedToUpsertOrg             Code = \"FailedToUpsertOrg\" FailedToSyncAc                Code = \"FailedToSyncAc\" FailedToAddedDefaultPolicy    Code = \"FailedToAddedDefaultPolicy\" FailedToUpsertAcGroups        Code = \"FailedToUpsertAcGroups\" FailedToSyncSubscriptions     Code = \"FailedToSyncSubscriptions\" EmailAlreadyExists            Code = \"EmailAlreadyExists\" MobileAlreadyExists           Code = \"MobileAlreadyExists\" InternalError                 Code = \"InternalError\" OrgAlreadyExists              Code = \"OrgAlreadyExists\" NotBelongThisOrg              Code = \"NotBelongThisOrg\" FailedToTransferCreator       Code = \"FailedToTransferCreator\" FailedToRemoveOrgMember       Code = \"FailedToRemoveOrgMember\" FailedToGetAcGroup            Code = \"FailedToGetAcGroup\"
	Code *string `json:"code,omitempty"`
	// Detail contains further information on the nature of the error.
	Detail *string `json:"detail,omitempty"`
	// Message is the error message.
	Msg *string `json:"msg,omitempty"`
	// TraceId is the identifier for a trace. It is globally unique.
	TraceId *string `json:"traceId,omitempty"`
	// Type A URI reference that identifies the error type.
	Type *string `json:"type,omitempty"`
}

JsonErrorResponse Error responses are sent when an error (e.g. unauthorized, bad request, ...) occurred.

func NewJsonErrorResponse 

func NewJsonErrorResponse() *JsonErrorResponse

NewJsonErrorResponse instantiates a new JsonErrorResponse 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 NewJsonErrorResponseWithDefaults 

func NewJsonErrorResponseWithDefaults() *JsonErrorResponse

NewJsonErrorResponseWithDefaults instantiates a new JsonErrorResponse 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 (*JsonErrorResponse) GetCode 

func (o *JsonErrorResponse) GetCode() string

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

func (*JsonErrorResponse) GetCodeOk 

func (o *JsonErrorResponse) 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 (*JsonErrorResponse) GetDetail 

func (o *JsonErrorResponse) GetDetail() string

GetDetail returns the Detail field value if set, zero value otherwise.

func (*JsonErrorResponse) GetDetailOk 

func (o *JsonErrorResponse) GetDetailOk() (*string, bool)

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

func (*JsonErrorResponse) GetMsg 

func (o *JsonErrorResponse) GetMsg() string

GetMsg returns the Msg field value if set, zero value otherwise.

func (*JsonErrorResponse) GetMsgOk 

func (o *JsonErrorResponse) GetMsgOk() (*string, bool)

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

func (*JsonErrorResponse) GetTraceId 

func (o *JsonErrorResponse) GetTraceId() string

GetTraceId returns the TraceId field value if set, zero value otherwise.

func (*JsonErrorResponse) GetTraceIdOk 

func (o *JsonErrorResponse) GetTraceIdOk() (*string, bool)

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

func (*JsonErrorResponse) GetType 

func (o *JsonErrorResponse) GetType() string

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

func (*JsonErrorResponse) GetTypeOk 

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

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

func (*JsonErrorResponse) HasCode 

func (o *JsonErrorResponse) HasCode() bool

HasCode returns a boolean if a field has been set.

func (*JsonErrorResponse) HasDetail 

func (o *JsonErrorResponse) HasDetail() bool

HasDetail returns a boolean if a field has been set.

func (*JsonErrorResponse) HasMsg 

func (o *JsonErrorResponse) HasMsg() bool

HasMsg returns a boolean if a field has been set.

func (*JsonErrorResponse) HasTraceId 

func (o *JsonErrorResponse) HasTraceId() bool

HasTraceId returns a boolean if a field has been set.

func (*JsonErrorResponse) HasType 

func (o *JsonErrorResponse) HasType() bool

HasType returns a boolean if a field has been set.

func (JsonErrorResponse) MarshalJSON 

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

func (*JsonErrorResponse) SetCode 

func (o *JsonErrorResponse) SetCode(v string)

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

func (*JsonErrorResponse) SetDetail 

func (o *JsonErrorResponse) SetDetail(v string)

SetDetail gets a reference to the given string and assigns it to the Detail field.

func (*JsonErrorResponse) SetMsg 

func (o *JsonErrorResponse) SetMsg(v string)

SetMsg gets a reference to the given string and assigns it to the Msg field.

func (*JsonErrorResponse) SetTraceId 

func (o *JsonErrorResponse) SetTraceId(v string)

SetTraceId gets a reference to the given string and assigns it to the TraceId field.

func (*JsonErrorResponse) SetType 

func (o *JsonErrorResponse) SetType(v string)

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

type NullableAddMembersResponse 

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

func NewNullableAddMembersResponse 

func NewNullableAddMembersResponse(val *AddMembersResponse) *NullableAddMembersResponse

func (NullableAddMembersResponse) Get 

func (v NullableAddMembersResponse) Get() *AddMembersResponse

func (NullableAddMembersResponse) IsSet 

func (v NullableAddMembersResponse) IsSet() bool

func (NullableAddMembersResponse) MarshalJSON 

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

func (*NullableAddMembersResponse) Set 

func (v *NullableAddMembersResponse) Set(val *AddMembersResponse)

func (*NullableAddMembersResponse) UnmarshalJSON 

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

func (*NullableAddMembersResponse) Unset 

func (v *NullableAddMembersResponse) Unset()

type NullableAddMembersResponseData 

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

func NewNullableAddMembersResponseData 

func NewNullableAddMembersResponseData(val *AddMembersResponseData) *NullableAddMembersResponseData

func (NullableAddMembersResponseData) Get 

func (v NullableAddMembersResponseData) Get() *AddMembersResponseData

func (NullableAddMembersResponseData) IsSet 

func (v NullableAddMembersResponseData) IsSet() bool

func (NullableAddMembersResponseData) MarshalJSON 

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

func (*NullableAddMembersResponseData) Set 

func (v *NullableAddMembersResponseData) Set(val *AddMembersResponseData)

func (*NullableAddMembersResponseData) UnmarshalJSON 

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

func (*NullableAddMembersResponseData) Unset 

func (v *NullableAddMembersResponseData) 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 NullableJsonErrorResponse 

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

func NewNullableJsonErrorResponse 

func NewNullableJsonErrorResponse(val *JsonErrorResponse) *NullableJsonErrorResponse

func (NullableJsonErrorResponse) Get 

func (v NullableJsonErrorResponse) Get() *JsonErrorResponse

func (NullableJsonErrorResponse) IsSet 

func (v NullableJsonErrorResponse) IsSet() bool

func (NullableJsonErrorResponse) MarshalJSON 

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

func (*NullableJsonErrorResponse) Set 

func (v *NullableJsonErrorResponse) Set(val *JsonErrorResponse)

func (*NullableJsonErrorResponse) UnmarshalJSON 

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

func (*NullableJsonErrorResponse) Unset 

func (v *NullableJsonErrorResponse) Unset()

type NullableOrganizatoinMember 

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

func NewNullableOrganizatoinMember 

func NewNullableOrganizatoinMember(val *OrganizatoinMember) *NullableOrganizatoinMember

func (NullableOrganizatoinMember) Get 

func (v NullableOrganizatoinMember) Get() *OrganizatoinMember

func (NullableOrganizatoinMember) IsSet 

func (v NullableOrganizatoinMember) IsSet() bool

func (NullableOrganizatoinMember) MarshalJSON 

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

func (*NullableOrganizatoinMember) Set 

func (v *NullableOrganizatoinMember) Set(val *OrganizatoinMember)

func (*NullableOrganizatoinMember) UnmarshalJSON 

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

func (*NullableOrganizatoinMember) Unset 

func (v *NullableOrganizatoinMember) 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 OrganizationApi 

type OrganizationApi interface {

	/*
		 * AddMembersRequest Add members to the organization
		 * This endpoint tells Configurator that some members is added to the organziation.

	The consent challenge is appended to the consent provider's URL to which the subject's user-agent (browser) is redirected to. The consent
	provider uses that challenge to fetch information on the OAuth2 request and then tells ORY Hydra if the subject accepted
	or rejected the request.

	The response contains information about the created user.
		 * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 * @return OrganizationApiApiAddMembersRequestRequest
	*/
	AddMembersRequest(ctx context.Context) OrganizationApiApiAddMembersRequestRequest

	/*
	 * AddMembersRequestExecute executes the request
	 * @return AddMembersResponse
	 */
	AddMembersRequestExecute(r OrganizationApiApiAddMembersRequestRequest) (*AddMembersResponse, *http.Response, error)
}

type OrganizationApiApiAddMembersRequestRequest 

type OrganizationApiApiAddMembersRequestRequest struct {
	ApiService OrganizationApi
	// contains filtered or unexported fields
}

func (OrganizationApiApiAddMembersRequestRequest) Execute 

func (r OrganizationApiApiAddMembersRequestRequest) Execute() (*AddMembersResponse, *http.Response, error)

func (OrganizationApiApiAddMembersRequestRequest) OrganizationId 

func (r OrganizationApiApiAddMembersRequestRequest) OrganizationId(organizationId int64) OrganizationApiApiAddMembersRequestRequest

func (OrganizationApiApiAddMembersRequestRequest) OrganizatoinMember 

func (r OrganizationApiApiAddMembersRequestRequest) OrganizatoinMember(organizatoinMember []OrganizatoinMember) OrganizationApiApiAddMembersRequestRequest

type OrganizationApiService 

type OrganizationApiService service

OrganizationApiService OrganizationApi service

func (*OrganizationApiService) AddMembersRequest 

func (a *OrganizationApiService) AddMembersRequest(ctx context.Context) OrganizationApiApiAddMembersRequestRequest
  • AddMembersRequest Add members to the organization
  • This endpoint tells Configurator that some members is added to the organziation.

The consent challenge is appended to the consent provider's URL to which the subject's user-agent (browser) is redirected to. The consent provider uses that challenge to fetch information on the OAuth2 request and then tells ORY Hydra if the subject accepted or rejected the request.

The response contains information about the created user.

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

func (*OrganizationApiService) AddMembersRequestExecute 

func (a *OrganizationApiService) AddMembersRequestExecute(r OrganizationApiApiAddMembersRequestRequest) (*AddMembersResponse, *http.Response, error)

* Execute executes the request * @return AddMembersResponse

type OrganizatoinMember 

type OrganizatoinMember struct {
	// Mail is email of the member.
	Mail string `json:"mail"`
	// Name is name of the member.
	Name string `json:"name"`
}

OrganizatoinMember struct for OrganizatoinMember

func NewOrganizatoinMember 

func NewOrganizatoinMember(mail string, name string) *OrganizatoinMember

NewOrganizatoinMember instantiates a new OrganizatoinMember 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 NewOrganizatoinMemberWithDefaults 

func NewOrganizatoinMemberWithDefaults() *OrganizatoinMember

NewOrganizatoinMemberWithDefaults instantiates a new OrganizatoinMember 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 (*OrganizatoinMember) GetMail 

func (o *OrganizatoinMember) GetMail() string

GetMail returns the Mail field value

func (*OrganizatoinMember) GetMailOk 

func (o *OrganizatoinMember) GetMailOk() (*string, bool)

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

func (*OrganizatoinMember) GetName 

func (o *OrganizatoinMember) GetName() string

GetName returns the Name field value

func (*OrganizatoinMember) GetNameOk 

func (o *OrganizatoinMember) GetNameOk() (*string, bool)

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

func (OrganizatoinMember) MarshalJSON 

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

func (*OrganizatoinMember) SetMail 

func (o *OrganizatoinMember) SetMail(v string)

SetMail sets field value

func (*OrganizatoinMember) SetName 

func (o *OrganizatoinMember) SetName(v string)

SetName sets field value

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

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.