business_units

package
v0.0.0-...-a445fe2 Latest Latest
Warning

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

 Go to latest Published: Mar 6, 2024 License: MIT Imports: 22 Imported by: 0

README

Go API client for business_units

Retrieve Business Unit information.

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: v3
  • 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 business_units "github.com/GIT_USER_ID/GIT_REPO_ID"

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

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

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

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

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

Documentation for API Endpoints

All URIs are relative to https://api.hubapi.com

Class Method HTTP request Description
BusinessUnitAPI GetBusinessUnitsV3BusinessUnitsUserUserIdGetByUserID Get /business-units/v3/business-units/user/{userId} Get Business Units for a user

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

oauth2_legacy

Example

auth := context.WithValue(context.Background(), business_units.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, business_units.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)
private_apps_legacy
  • Type: API key
  • API key parameter name: private-app-legacy
  • Location: HTTP header

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

Example

auth := context.WithValue(
		context.Background(),
		business_units.ContextAPIKeys,
		map[string]business_units.APIKey{
			"private-app-legacy": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

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

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

Author

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	JsonCheck = regexp.MustCompile(`(?i:(?:application|text)/(?:[^;]+\+)?json)`)
	XmlCheck  = regexp.MustCompile(`(?i:(?:application|text)/(?:[^;]+\+)?xml)`)
)
View Source 
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

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

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

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

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

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

Functions

func CacheExpires 

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

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

func IsNil 

func IsNil(i interface{}) bool

IsNil checks if an input is nil

func PtrBool 

func PtrBool(v bool) *bool

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

func PtrFloat32 

func PtrFloat32(v float32) *float32

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

func PtrFloat64 

func PtrFloat64(v float64) *float64

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

func PtrInt 

func PtrInt(v int) *int

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

func PtrInt32 

func PtrInt32(v int32) *int32

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

func PtrInt64 

func PtrInt64(v int64) *int64

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

func PtrString 

func PtrString(v string) *string

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

func PtrTime 

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

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

Types

type APIClient 

type APIClient struct {
	BusinessUnitAPI *BusinessUnitAPIService
	// contains filtered or unexported fields
}

APIClient manages communication with the Business Units API vv3 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 ApiGetBusinessUnitsV3BusinessUnitsUserUserIdGetByUserIDRequest 

type ApiGetBusinessUnitsV3BusinessUnitsUserUserIdGetByUserIDRequest struct {
	ApiService *BusinessUnitAPIService
	// contains filtered or unexported fields
}

func (ApiGetBusinessUnitsV3BusinessUnitsUserUserIdGetByUserIDRequest) Execute 

func (r ApiGetBusinessUnitsV3BusinessUnitsUserUserIdGetByUserIDRequest) Execute() (*CollectionResponsePublicBusinessUnitNoPaging, *http.Response, error)

func (ApiGetBusinessUnitsV3BusinessUnitsUserUserIdGetByUserIDRequest) Name 

func (r ApiGetBusinessUnitsV3BusinessUnitsUserUserIdGetByUserIDRequest) Name(name []string) ApiGetBusinessUnitsV3BusinessUnitsUserUserIdGetByUserIDRequest

The names of Business Units to retrieve. If empty or not provided, then all associated Business Units will be returned.

func (ApiGetBusinessUnitsV3BusinessUnitsUserUserIdGetByUserIDRequest) Properties 

func (r ApiGetBusinessUnitsV3BusinessUnitsUserUserIdGetByUserIDRequest) Properties(properties []string) ApiGetBusinessUnitsV3BusinessUnitsUserUserIdGetByUserIDRequest

The names of properties to optionally include in the response body. The only valid value is `logoMetadata`.

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 BusinessUnitAPIService 

type BusinessUnitAPIService service

BusinessUnitAPIService BusinessUnitAPI service

func (*BusinessUnitAPIService) GetBusinessUnitsV3BusinessUnitsUserUserIdGetByUserID 

func (a *BusinessUnitAPIService) GetBusinessUnitsV3BusinessUnitsUserUserIdGetByUserID(ctx context.Context, userId string) ApiGetBusinessUnitsV3BusinessUnitsUserUserIdGetByUserIDRequest

GetBusinessUnitsV3BusinessUnitsUserUserIdGetByUserID Get Business Units for a user

Get Business Units identified by `userId`. The `userId` refers to the user’s ID. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param userId Identifier of user to retrieve.
@return ApiGetBusinessUnitsV3BusinessUnitsUserUserIdGetByUserIDRequest

func (*BusinessUnitAPIService) GetBusinessUnitsV3BusinessUnitsUserUserIdGetByUserIDExecute 

func (a *BusinessUnitAPIService) GetBusinessUnitsV3BusinessUnitsUserUserIdGetByUserIDExecute(r ApiGetBusinessUnitsV3BusinessUnitsUserUserIdGetByUserIDRequest) (*CollectionResponsePublicBusinessUnitNoPaging, *http.Response, error)

Execute executes the request 

@return CollectionResponsePublicBusinessUnitNoPaging

type CollectionResponsePublicBusinessUnitNoPaging 

type CollectionResponsePublicBusinessUnitNoPaging struct {
	// The collection of Business Units
	Results []PublicBusinessUnit `json:"results"`
}

CollectionResponsePublicBusinessUnitNoPaging A response object containing a collection of Business Units

func NewCollectionResponsePublicBusinessUnitNoPaging 

func NewCollectionResponsePublicBusinessUnitNoPaging(results []PublicBusinessUnit) *CollectionResponsePublicBusinessUnitNoPaging

NewCollectionResponsePublicBusinessUnitNoPaging instantiates a new CollectionResponsePublicBusinessUnitNoPaging 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 NewCollectionResponsePublicBusinessUnitNoPagingWithDefaults 

func NewCollectionResponsePublicBusinessUnitNoPagingWithDefaults() *CollectionResponsePublicBusinessUnitNoPaging

NewCollectionResponsePublicBusinessUnitNoPagingWithDefaults instantiates a new CollectionResponsePublicBusinessUnitNoPaging 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 (*CollectionResponsePublicBusinessUnitNoPaging) GetResults 

func (o *CollectionResponsePublicBusinessUnitNoPaging) GetResults() []PublicBusinessUnit

GetResults returns the Results field value

func (*CollectionResponsePublicBusinessUnitNoPaging) GetResultsOk 

func (o *CollectionResponsePublicBusinessUnitNoPaging) GetResultsOk() ([]PublicBusinessUnit, bool)

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

func (CollectionResponsePublicBusinessUnitNoPaging) MarshalJSON 

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

func (*CollectionResponsePublicBusinessUnitNoPaging) SetResults 

func (o *CollectionResponsePublicBusinessUnitNoPaging) SetResults(v []PublicBusinessUnit)

SetResults sets field value

func (CollectionResponsePublicBusinessUnitNoPaging) ToMap 

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

func (*CollectionResponsePublicBusinessUnitNoPaging) UnmarshalJSON 

func (o *CollectionResponsePublicBusinessUnitNoPaging) 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"`
	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 {
	// A specific category that contains more specific detail about the error
	SubCategory *string `json:"subCategory,omitempty"`
	// Context about the error condition
	Context *map[string][]string `json:"context,omitempty"`
	// A unique identifier for the request. Include this value with any error reports or support tickets
	CorrelationId string `json:"correlationId"`
	// A map of link names to associated URIs containing documentation about the error or recommended remediation steps
	Links *map[string]string `json:"links,omitempty"`
	// A human readable message describing the error along with remediation steps where appropriate
	Message string `json:"message"`
	// The error category
	Category string `json:"category"`
	// further information about the error
	Errors []ErrorDetail `json:"errors,omitempty"`
}

Error struct for Error

func NewError 

func NewError(correlationId string, message string, category 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) GetCategory 

func (o *Error) GetCategory() string

GetCategory returns the Category field value

func (*Error) GetCategoryOk 

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

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

func (*Error) GetContext 

func (o *Error) GetContext() map[string][]string

GetContext returns the Context field value if set, zero value otherwise.

func (*Error) GetContextOk 

func (o *Error) GetContextOk() (*map[string][]string, bool)

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

func (*Error) GetCorrelationId 

func (o *Error) GetCorrelationId() string

GetCorrelationId returns the CorrelationId field value

func (*Error) GetCorrelationIdOk 

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

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

func (*Error) GetErrors 

func (o *Error) GetErrors() []ErrorDetail

GetErrors returns the Errors field value if set, zero value otherwise.

func (*Error) GetErrorsOk 

func (o *Error) GetErrorsOk() ([]ErrorDetail, bool)

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

func (o *Error) GetLinks() map[string]string

GetLinks returns the Links field value if set, zero value otherwise.

func (*Error) GetLinksOk 

func (o *Error) GetLinksOk() (*map[string]string, bool)

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

func (*Error) GetMessage 

func (o *Error) GetMessage() string

GetMessage returns the Message field value

func (*Error) GetMessageOk 

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

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

func (*Error) GetSubCategory 

func (o *Error) GetSubCategory() string

GetSubCategory returns the SubCategory field value if set, zero value otherwise.

func (*Error) GetSubCategoryOk 

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

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

func (*Error) HasContext 

func (o *Error) HasContext() bool

HasContext returns a boolean if a field has been set.

func (*Error) HasErrors 

func (o *Error) HasErrors() bool

HasErrors returns a boolean if a field has been set. 

func (o *Error) HasLinks() bool

HasLinks returns a boolean if a field has been set.

func (*Error) HasSubCategory 

func (o *Error) HasSubCategory() bool

HasSubCategory returns a boolean if a field has been set.

func (Error) MarshalJSON 

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

func (*Error) SetCategory 

func (o *Error) SetCategory(v string)

SetCategory sets field value

func (*Error) SetContext 

func (o *Error) SetContext(v map[string][]string)

SetContext gets a reference to the given map[string][]string and assigns it to the Context field.

func (*Error) SetCorrelationId 

func (o *Error) SetCorrelationId(v string)

SetCorrelationId sets field value

func (*Error) SetErrors 

func (o *Error) SetErrors(v []ErrorDetail)

SetErrors gets a reference to the given []ErrorDetail and assigns it to the Errors field. 

func (o *Error) SetLinks(v map[string]string)

SetLinks gets a reference to the given map[string]string and assigns it to the Links field.

func (*Error) SetMessage 

func (o *Error) SetMessage(v string)

SetMessage sets field value

func (*Error) SetSubCategory 

func (o *Error) SetSubCategory(v string)

SetSubCategory gets a reference to the given string and assigns it to the SubCategory field.

func (Error) ToMap 

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

func (*Error) UnmarshalJSON 

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

type ErrorDetail 

type ErrorDetail struct {
	// A specific category that contains more specific detail about the error
	SubCategory *string `json:"subCategory,omitempty"`
	// The status code associated with the error detail
	Code *string `json:"code,omitempty"`
	// The name of the field or parameter in which the error was found.
	In *string `json:"in,omitempty"`
	// Context about the error condition
	Context *map[string][]string `json:"context,omitempty"`
	// A human readable message describing the error along with remediation steps where appropriate
	Message string `json:"message"`
}

ErrorDetail struct for ErrorDetail

func NewErrorDetail 

func NewErrorDetail(message string) *ErrorDetail

NewErrorDetail instantiates a new ErrorDetail 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 NewErrorDetailWithDefaults 

func NewErrorDetailWithDefaults() *ErrorDetail

NewErrorDetailWithDefaults instantiates a new ErrorDetail 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 (*ErrorDetail) GetCode 

func (o *ErrorDetail) GetCode() string

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

func (*ErrorDetail) GetCodeOk 

func (o *ErrorDetail) 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 (*ErrorDetail) GetContext 

func (o *ErrorDetail) GetContext() map[string][]string

GetContext returns the Context field value if set, zero value otherwise.

func (*ErrorDetail) GetContextOk 

func (o *ErrorDetail) GetContextOk() (*map[string][]string, bool)

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

func (*ErrorDetail) GetIn 

func (o *ErrorDetail) GetIn() string

GetIn returns the In field value if set, zero value otherwise.

func (*ErrorDetail) GetInOk 

func (o *ErrorDetail) GetInOk() (*string, bool)

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

func (*ErrorDetail) GetMessage 

func (o *ErrorDetail) GetMessage() string

GetMessage returns the Message field value

func (*ErrorDetail) GetMessageOk 

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

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

func (*ErrorDetail) GetSubCategory 

func (o *ErrorDetail) GetSubCategory() string

GetSubCategory returns the SubCategory field value if set, zero value otherwise.

func (*ErrorDetail) GetSubCategoryOk 

func (o *ErrorDetail) GetSubCategoryOk() (*string, bool)

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

func (*ErrorDetail) HasCode 

func (o *ErrorDetail) HasCode() bool

HasCode returns a boolean if a field has been set.

func (*ErrorDetail) HasContext 

func (o *ErrorDetail) HasContext() bool

HasContext returns a boolean if a field has been set.

func (*ErrorDetail) HasIn 

func (o *ErrorDetail) HasIn() bool

HasIn returns a boolean if a field has been set.

func (*ErrorDetail) HasSubCategory 

func (o *ErrorDetail) HasSubCategory() bool

HasSubCategory returns a boolean if a field has been set.

func (ErrorDetail) MarshalJSON 

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

func (*ErrorDetail) SetCode 

func (o *ErrorDetail) SetCode(v string)

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

func (*ErrorDetail) SetContext 

func (o *ErrorDetail) SetContext(v map[string][]string)

SetContext gets a reference to the given map[string][]string and assigns it to the Context field.

func (*ErrorDetail) SetIn 

func (o *ErrorDetail) SetIn(v string)

SetIn gets a reference to the given string and assigns it to the In field.

func (*ErrorDetail) SetMessage 

func (o *ErrorDetail) SetMessage(v string)

SetMessage sets field value

func (*ErrorDetail) SetSubCategory 

func (o *ErrorDetail) SetSubCategory(v string)

SetSubCategory gets a reference to the given string and assigns it to the SubCategory field.

func (ErrorDetail) ToMap 

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

func (*ErrorDetail) UnmarshalJSON 

func (o *ErrorDetail) 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 NullableCollectionResponsePublicBusinessUnitNoPaging 

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

func NewNullableCollectionResponsePublicBusinessUnitNoPaging 

func NewNullableCollectionResponsePublicBusinessUnitNoPaging(val *CollectionResponsePublicBusinessUnitNoPaging) *NullableCollectionResponsePublicBusinessUnitNoPaging

func (NullableCollectionResponsePublicBusinessUnitNoPaging) Get 

func (v NullableCollectionResponsePublicBusinessUnitNoPaging) Get() *CollectionResponsePublicBusinessUnitNoPaging

func (NullableCollectionResponsePublicBusinessUnitNoPaging) IsSet 

func (v NullableCollectionResponsePublicBusinessUnitNoPaging) IsSet() bool

func (NullableCollectionResponsePublicBusinessUnitNoPaging) MarshalJSON 

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

func (*NullableCollectionResponsePublicBusinessUnitNoPaging) Set 

func (v *NullableCollectionResponsePublicBusinessUnitNoPaging) Set(val *CollectionResponsePublicBusinessUnitNoPaging)

func (*NullableCollectionResponsePublicBusinessUnitNoPaging) UnmarshalJSON 

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

func (*NullableCollectionResponsePublicBusinessUnitNoPaging) Unset 

func (v *NullableCollectionResponsePublicBusinessUnitNoPaging) 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 NullableErrorDetail 

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

func NewNullableErrorDetail 

func NewNullableErrorDetail(val *ErrorDetail) *NullableErrorDetail

func (NullableErrorDetail) Get 

func (v NullableErrorDetail) Get() *ErrorDetail

func (NullableErrorDetail) IsSet 

func (v NullableErrorDetail) IsSet() bool

func (NullableErrorDetail) MarshalJSON 

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

func (*NullableErrorDetail) Set 

func (v *NullableErrorDetail) Set(val *ErrorDetail)

func (*NullableErrorDetail) UnmarshalJSON 

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

func (*NullableErrorDetail) Unset 

func (v *NullableErrorDetail) 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 NullablePublicBusinessUnit 

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

func NewNullablePublicBusinessUnit 

func NewNullablePublicBusinessUnit(val *PublicBusinessUnit) *NullablePublicBusinessUnit

func (NullablePublicBusinessUnit) Get 

func (v NullablePublicBusinessUnit) Get() *PublicBusinessUnit

func (NullablePublicBusinessUnit) IsSet 

func (v NullablePublicBusinessUnit) IsSet() bool

func (NullablePublicBusinessUnit) MarshalJSON 

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

func (*NullablePublicBusinessUnit) Set 

func (v *NullablePublicBusinessUnit) Set(val *PublicBusinessUnit)

func (*NullablePublicBusinessUnit) UnmarshalJSON 

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

func (*NullablePublicBusinessUnit) Unset 

func (v *NullablePublicBusinessUnit) Unset()

type NullablePublicBusinessUnitLogoMetadata 

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

func NewNullablePublicBusinessUnitLogoMetadata 

func NewNullablePublicBusinessUnitLogoMetadata(val *PublicBusinessUnitLogoMetadata) *NullablePublicBusinessUnitLogoMetadata

func (NullablePublicBusinessUnitLogoMetadata) Get 

func (v NullablePublicBusinessUnitLogoMetadata) Get() *PublicBusinessUnitLogoMetadata

func (NullablePublicBusinessUnitLogoMetadata) IsSet 

func (v NullablePublicBusinessUnitLogoMetadata) IsSet() bool

func (NullablePublicBusinessUnitLogoMetadata) MarshalJSON 

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

func (*NullablePublicBusinessUnitLogoMetadata) Set 

func (v *NullablePublicBusinessUnitLogoMetadata) Set(val *PublicBusinessUnitLogoMetadata)

func (*NullablePublicBusinessUnitLogoMetadata) UnmarshalJSON 

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

func (*NullablePublicBusinessUnitLogoMetadata) Unset 

func (v *NullablePublicBusinessUnitLogoMetadata) 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 PublicBusinessUnit 

type PublicBusinessUnit struct {
	LogoMetadata *PublicBusinessUnitLogoMetadata `json:"logoMetadata,omitempty"`
	// The Business Unit's name
	Name string `json:"name"`
	// The Business Unit's unique ID
	Id string `json:"id"`
}

PublicBusinessUnit A Business Unit

func NewPublicBusinessUnit 

func NewPublicBusinessUnit(name string, id string) *PublicBusinessUnit

NewPublicBusinessUnit instantiates a new PublicBusinessUnit 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 NewPublicBusinessUnitWithDefaults 

func NewPublicBusinessUnitWithDefaults() *PublicBusinessUnit

NewPublicBusinessUnitWithDefaults instantiates a new PublicBusinessUnit 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 (*PublicBusinessUnit) GetId 

func (o *PublicBusinessUnit) GetId() string

GetId returns the Id field value

func (*PublicBusinessUnit) GetIdOk 

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

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

func (*PublicBusinessUnit) GetLogoMetadata 

func (o *PublicBusinessUnit) GetLogoMetadata() PublicBusinessUnitLogoMetadata

GetLogoMetadata returns the LogoMetadata field value if set, zero value otherwise.

func (*PublicBusinessUnit) GetLogoMetadataOk 

func (o *PublicBusinessUnit) GetLogoMetadataOk() (*PublicBusinessUnitLogoMetadata, bool)

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

func (*PublicBusinessUnit) GetName 

func (o *PublicBusinessUnit) GetName() string

GetName returns the Name field value

func (*PublicBusinessUnit) GetNameOk 

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

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

func (*PublicBusinessUnit) HasLogoMetadata 

func (o *PublicBusinessUnit) HasLogoMetadata() bool

HasLogoMetadata returns a boolean if a field has been set.

func (PublicBusinessUnit) MarshalJSON 

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

func (*PublicBusinessUnit) SetId 

func (o *PublicBusinessUnit) SetId(v string)

SetId sets field value

func (*PublicBusinessUnit) SetLogoMetadata 

func (o *PublicBusinessUnit) SetLogoMetadata(v PublicBusinessUnitLogoMetadata)

SetLogoMetadata gets a reference to the given PublicBusinessUnitLogoMetadata and assigns it to the LogoMetadata field.

func (*PublicBusinessUnit) SetName 

func (o *PublicBusinessUnit) SetName(v string)

SetName sets field value

func (PublicBusinessUnit) ToMap 

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

func (*PublicBusinessUnit) UnmarshalJSON 

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

type PublicBusinessUnitLogoMetadata 

type PublicBusinessUnitLogoMetadata struct {
	// The logo's alt text
	LogoAltText *string `json:"logoAltText,omitempty"`
	// The logo's resized url
	ResizedUrl *string `json:"resizedUrl,omitempty"`
	// The logo's url
	LogoUrl *string `json:"logoUrl,omitempty"`
}

PublicBusinessUnitLogoMetadata A Business Unit's logo metadata

func NewPublicBusinessUnitLogoMetadata 

func NewPublicBusinessUnitLogoMetadata() *PublicBusinessUnitLogoMetadata

NewPublicBusinessUnitLogoMetadata instantiates a new PublicBusinessUnitLogoMetadata 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 NewPublicBusinessUnitLogoMetadataWithDefaults 

func NewPublicBusinessUnitLogoMetadataWithDefaults() *PublicBusinessUnitLogoMetadata

NewPublicBusinessUnitLogoMetadataWithDefaults instantiates a new PublicBusinessUnitLogoMetadata 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 (*PublicBusinessUnitLogoMetadata) GetLogoAltText 

func (o *PublicBusinessUnitLogoMetadata) GetLogoAltText() string

GetLogoAltText returns the LogoAltText field value if set, zero value otherwise.

func (*PublicBusinessUnitLogoMetadata) GetLogoAltTextOk 

func (o *PublicBusinessUnitLogoMetadata) GetLogoAltTextOk() (*string, bool)

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

func (*PublicBusinessUnitLogoMetadata) GetLogoUrl 

func (o *PublicBusinessUnitLogoMetadata) GetLogoUrl() string

GetLogoUrl returns the LogoUrl field value if set, zero value otherwise.

func (*PublicBusinessUnitLogoMetadata) GetLogoUrlOk 

func (o *PublicBusinessUnitLogoMetadata) GetLogoUrlOk() (*string, bool)

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

func (*PublicBusinessUnitLogoMetadata) GetResizedUrl 

func (o *PublicBusinessUnitLogoMetadata) GetResizedUrl() string

GetResizedUrl returns the ResizedUrl field value if set, zero value otherwise.

func (*PublicBusinessUnitLogoMetadata) GetResizedUrlOk 

func (o *PublicBusinessUnitLogoMetadata) GetResizedUrlOk() (*string, bool)

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

func (*PublicBusinessUnitLogoMetadata) HasLogoAltText 

func (o *PublicBusinessUnitLogoMetadata) HasLogoAltText() bool

HasLogoAltText returns a boolean if a field has been set.

func (*PublicBusinessUnitLogoMetadata) HasLogoUrl 

func (o *PublicBusinessUnitLogoMetadata) HasLogoUrl() bool

HasLogoUrl returns a boolean if a field has been set.

func (*PublicBusinessUnitLogoMetadata) HasResizedUrl 

func (o *PublicBusinessUnitLogoMetadata) HasResizedUrl() bool

HasResizedUrl returns a boolean if a field has been set.

func (PublicBusinessUnitLogoMetadata) MarshalJSON 

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

func (*PublicBusinessUnitLogoMetadata) SetLogoAltText 

func (o *PublicBusinessUnitLogoMetadata) SetLogoAltText(v string)

SetLogoAltText gets a reference to the given string and assigns it to the LogoAltText field.

func (*PublicBusinessUnitLogoMetadata) SetLogoUrl 

func (o *PublicBusinessUnitLogoMetadata) SetLogoUrl(v string)

SetLogoUrl gets a reference to the given string and assigns it to the LogoUrl field.

func (*PublicBusinessUnitLogoMetadata) SetResizedUrl 

func (o *PublicBusinessUnitLogoMetadata) SetResizedUrl(v string)

SetResizedUrl gets a reference to the given string and assigns it to the ResizedUrl field.

func (PublicBusinessUnitLogoMetadata) ToMap 

func (o PublicBusinessUnitLogoMetadata) ToMap() (map[string]interface{}, 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

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.