isp

package
v1.27.0 Latest Latest
Warning

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

 Go to latest Published: Dec 13, 2024 License: Apache-2.0 Imports: 24 Imported by: 0

Documentation

Index

Constants

View Source 
const RelNext = "next"

RelNext is the `next` link relationship, used for pagination.

Variables

View Source 
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

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

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

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

	// ContextOperationServerVariables overrides a server configuration variables using operation specific values.
	ContextOperationServerVariables = contextKey("serverOperationVariables")
)
View Source 
var (
	// ContextDisablePaging disable automatic pagination handling for a request.
	ContextDisablePaging = contextKey("paging")
)

Functions

func CacheExpires 

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

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

func GetLink(resp *http.Response, rel string) *url.URL

GetLink returns the URI of the first HTTP Link header with the requested relationship value, nil otherwise.

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

APIClient manages communication with the iStreamPlanet Slate Management API API v1.0.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) GetConfig 

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResponse object.

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

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

type ApiDeleteOrgSlateRequest 

type ApiDeleteOrgSlateRequest struct {
	ApiService SlatesForOrganizationApi
	// contains filtered or unexported fields
}

func (ApiDeleteOrgSlateRequest) Execute 

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

type ApiGetOrgSlateRequest 

type ApiGetOrgSlateRequest struct {
	ApiService SlatesForOrganizationApi
	// contains filtered or unexported fields
}

func (ApiGetOrgSlateRequest) Execute 

func (r ApiGetOrgSlateRequest) Execute() (*Slate, *http.Response, error)

type ApiListOrgSlatesRequest 

type ApiListOrgSlatesRequest struct {
	ApiService SlatesForOrganizationApi
	// contains filtered or unexported fields
}

func (ApiListOrgSlatesRequest) Execute 

func (r ApiListOrgSlatesRequest) Execute() ([]Slate2, *http.Response, error)

type ApiPutOrgSlateRequest 

type ApiPutOrgSlateRequest struct {
	ApiService SlatesForOrganizationApi
	// contains filtered or unexported fields
}

func (ApiPutOrgSlateRequest) Execute 

func (r ApiPutOrgSlateRequest) Execute() (*Slate, *http.Response, error)

func (ApiPutOrgSlateRequest) SlateWithoutID 

func (r ApiPutOrgSlateRequest) SlateWithoutID(slateWithoutID SlateWithoutID) ApiPutOrgSlateRequest

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 ErrorModel 

type ErrorModel struct {
	// An optional URL to a JSON Schema document describing this resource
	Schema *string `json:"$schema,omitempty" format:"uri" doc:"An optional URL to a JSON Schema document describing this resource"`
	// A human-readable explanation specific to this occurrence of the problem.
	Detail *string `json:"detail,omitempty" doc:"A human-readable explanation specific to this occurrence of the problem."`
	// Optional list of individual error details
	Errors []ErrorModelErrorsInner `json:"errors,omitempty" doc:"Optional list of individual error details"`
	// A URI reference that identifies the specific occurence of the problem.
	Instance *string `json:"instance,omitempty" format:"uri" doc:"A URI reference that identifies the specific occurence of the problem."`
	// HTTP status code
	Status *int32 `json:"status,omitempty" format:"int32" doc:"HTTP status code"`
	// A short, human-readable summary of the problem type. This value should not change between occurances of the error.
	Title *string `` /* 143-byte string literal not displayed */
	// A URI reference to human-readable documentation for the error.
	Type *string `` /* 127-byte string literal not displayed */
}

ErrorModel struct for ErrorModel

func NewErrorModel 

func NewErrorModel() *ErrorModel

NewErrorModel instantiates a new ErrorModel 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 NewErrorModelWithDefaults 

func NewErrorModelWithDefaults() *ErrorModel

NewErrorModelWithDefaults instantiates a new ErrorModel 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 (*ErrorModel) GetDetail 

func (o *ErrorModel) GetDetail() string

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

func (*ErrorModel) GetDetailOk 

func (o *ErrorModel) 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 (*ErrorModel) GetErrors 

func (o *ErrorModel) GetErrors() []ErrorModelErrorsInner

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

func (*ErrorModel) GetErrorsOk 

func (o *ErrorModel) GetErrorsOk() ([]ErrorModelErrorsInner, 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 (*ErrorModel) GetInstance 

func (o *ErrorModel) GetInstance() string

GetInstance returns the Instance field value if set, zero value otherwise.

func (*ErrorModel) GetInstanceOk 

func (o *ErrorModel) GetInstanceOk() (*string, bool)

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

func (*ErrorModel) GetSchema 

func (o *ErrorModel) GetSchema() string

GetSchema returns the Schema field value if set, zero value otherwise.

func (*ErrorModel) GetSchemaOk 

func (o *ErrorModel) GetSchemaOk() (*string, bool)

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

func (*ErrorModel) GetStatus 

func (o *ErrorModel) GetStatus() int32

GetStatus returns the Status field value if set, zero value otherwise.

func (*ErrorModel) GetStatusOk 

func (o *ErrorModel) GetStatusOk() (*int32, bool)

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

func (*ErrorModel) GetTitle 

func (o *ErrorModel) GetTitle() string

GetTitle returns the Title field value if set, zero value otherwise.

func (*ErrorModel) GetTitleOk 

func (o *ErrorModel) GetTitleOk() (*string, bool)

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

func (*ErrorModel) GetType 

func (o *ErrorModel) GetType() string

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

func (*ErrorModel) GetTypeOk 

func (o *ErrorModel) 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 (*ErrorModel) HasDetail 

func (o *ErrorModel) HasDetail() bool

HasDetail returns a boolean if a field has been set.

func (*ErrorModel) HasErrors 

func (o *ErrorModel) HasErrors() bool

HasErrors returns a boolean if a field has been set.

func (*ErrorModel) HasInstance 

func (o *ErrorModel) HasInstance() bool

HasInstance returns a boolean if a field has been set.

func (*ErrorModel) HasSchema 

func (o *ErrorModel) HasSchema() bool

HasSchema returns a boolean if a field has been set.

func (*ErrorModel) HasStatus 

func (o *ErrorModel) HasStatus() bool

HasStatus returns a boolean if a field has been set.

func (*ErrorModel) HasTitle 

func (o *ErrorModel) HasTitle() bool

HasTitle returns a boolean if a field has been set.

func (*ErrorModel) HasType 

func (o *ErrorModel) HasType() bool

HasType returns a boolean if a field has been set.

func (ErrorModel) MarshalJSON 

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

func (*ErrorModel) SetDetail 

func (o *ErrorModel) SetDetail(v string)

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

func (*ErrorModel) SetErrors 

func (o *ErrorModel) SetErrors(v []ErrorModelErrorsInner)

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

func (*ErrorModel) SetInstance 

func (o *ErrorModel) SetInstance(v string)

SetInstance gets a reference to the given string and assigns it to the Instance field.

func (*ErrorModel) SetSchema 

func (o *ErrorModel) SetSchema(v string)

SetSchema gets a reference to the given string and assigns it to the Schema field.

func (*ErrorModel) SetStatus 

func (o *ErrorModel) SetStatus(v int32)

SetStatus gets a reference to the given int32 and assigns it to the Status field.

func (*ErrorModel) SetTitle 

func (o *ErrorModel) SetTitle(v string)

SetTitle gets a reference to the given string and assigns it to the Title field.

func (*ErrorModel) SetType 

func (o *ErrorModel) SetType(v string)

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

func (ErrorModel) ToMap 

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

type ErrorModelErrorsInner 

type ErrorModelErrorsInner struct {
	// Where the error occured, e.g. 'body.items[3].tags' or 'path.thing-id'
	Location *string `json:"location,omitempty" doc:"Where the error occured, e.g. 'body.items[3].tags' or 'path.thing-id'"`
	// Error message text
	Message *string `json:"message,omitempty" doc:"Error message text"`
	// The value at the given location
	Value interface{} `json:"value,omitempty" doc:"The value at the given location"`
}

ErrorModelErrorsInner struct for ErrorModelErrorsInner

func NewErrorModelErrorsInner 

func NewErrorModelErrorsInner() *ErrorModelErrorsInner

NewErrorModelErrorsInner instantiates a new ErrorModelErrorsInner 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 NewErrorModelErrorsInnerWithDefaults 

func NewErrorModelErrorsInnerWithDefaults() *ErrorModelErrorsInner

NewErrorModelErrorsInnerWithDefaults instantiates a new ErrorModelErrorsInner 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 (*ErrorModelErrorsInner) GetLocation 

func (o *ErrorModelErrorsInner) GetLocation() string

GetLocation returns the Location field value if set, zero value otherwise.

func (*ErrorModelErrorsInner) GetLocationOk 

func (o *ErrorModelErrorsInner) GetLocationOk() (*string, bool)

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

func (*ErrorModelErrorsInner) GetMessage 

func (o *ErrorModelErrorsInner) GetMessage() string

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

func (*ErrorModelErrorsInner) GetMessageOk 

func (o *ErrorModelErrorsInner) 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 (*ErrorModelErrorsInner) GetValue 

func (o *ErrorModelErrorsInner) GetValue() interface{}

GetValue returns the Value field value if set, zero value otherwise (both if not set or set to explicit null).

func (*ErrorModelErrorsInner) GetValueOk 

func (o *ErrorModelErrorsInner) GetValueOk() (*interface{}, bool)

GetValueOk returns a tuple with the Value field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*ErrorModelErrorsInner) HasLocation 

func (o *ErrorModelErrorsInner) HasLocation() bool

HasLocation returns a boolean if a field has been set.

func (*ErrorModelErrorsInner) HasMessage 

func (o *ErrorModelErrorsInner) HasMessage() bool

HasMessage returns a boolean if a field has been set.

func (*ErrorModelErrorsInner) HasValue 

func (o *ErrorModelErrorsInner) HasValue() bool

HasValue returns a boolean if a field has been set.

func (ErrorModelErrorsInner) MarshalJSON 

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

func (*ErrorModelErrorsInner) SetLocation 

func (o *ErrorModelErrorsInner) SetLocation(v string)

SetLocation gets a reference to the given string and assigns it to the Location field.

func (*ErrorModelErrorsInner) SetMessage 

func (o *ErrorModelErrorsInner) SetMessage(v string)

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

func (*ErrorModelErrorsInner) SetValue 

func (o *ErrorModelErrorsInner) SetValue(v interface{})

SetValue gets a reference to the given interface{} and assigns it to the Value field.

func (ErrorModelErrorsInner) ToMap 

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

type HighLevelClient struct {
	*APIClient
	*http.Client
}

HighLevelClient wraps an APIClient and http.Client, as well as providing custom high-level functionality.

func NewWithAuthHeader 

func NewWithAuthHeader(header string) *HighLevelClient

NewWithAuthHeader creates a new authenticated client using the given authorization header. The header format should be `Bearer <token>`, where `<token>` is replaced by the contents of the encoded & signed JWT.

func NewWithClientCredentials 

func NewWithClientCredentials(clientID, clientSecret, organization string) *HighLevelClient

NewWithClientCredentials creates a new authenticated client using the OAuth 2.0 client credentials flow, caching and refreshing the access token as needed whenever requests to the API are made. Leave the organization blank if using multi-org tokens.

func NewWithOktaClientCredentials added in v1.26.1 

func NewWithOktaClientCredentials(clientID, clientSecret string) *HighLevelClient

NewWithOktaClientCredentials creates a new authenticated client using the OAuth 2.0 client credentials flow, caching and refreshing the access token as needed whenever requests to the API are made. Leave the organization blank if using multi-org tokens. It is specific to WBD-Okta and replaces NewWithClientCredentials.

func (*HighLevelClient) Decode 

func (c *HighLevelClient) Decode(v interface{}, body []byte, contentType string) error

Decode a response body based on the content type.

func (*HighLevelClient) Do 

func (c *HighLevelClient) Do(req *http.Request) (*http.Response, error)

Do the request, logging the request/response if debugging is enabled.

func (*HighLevelClient) DoModel 

func (c *HighLevelClient) DoModel(req *http.Request, model interface{}) (*http.Response, error)

DoModel takes an HTTP request like http.Client.Do and makes the request. If successful, it also loads the model from the response.

func (*HighLevelClient) GetModel 

func (c *HighLevelClient) GetModel(uri string, model interface{}) (*http.Response, error)

GetModel performs an HTTP GET on the given URI and loads the model from the response if successful.

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 NullableErrorModel 

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

func NewNullableErrorModel 

func NewNullableErrorModel(val *ErrorModel) *NullableErrorModel

func (NullableErrorModel) Get 

func (v NullableErrorModel) Get() *ErrorModel

func (NullableErrorModel) IsSet 

func (v NullableErrorModel) IsSet() bool

func (NullableErrorModel) MarshalJSON 

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

func (*NullableErrorModel) Set 

func (v *NullableErrorModel) Set(val *ErrorModel)

func (*NullableErrorModel) UnmarshalJSON 

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

func (*NullableErrorModel) Unset 

func (v *NullableErrorModel) Unset()

type NullableErrorModelErrorsInner 

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

func NewNullableErrorModelErrorsInner 

func NewNullableErrorModelErrorsInner(val *ErrorModelErrorsInner) *NullableErrorModelErrorsInner

func (NullableErrorModelErrorsInner) Get 

func (v NullableErrorModelErrorsInner) Get() *ErrorModelErrorsInner

func (NullableErrorModelErrorsInner) IsSet 

func (v NullableErrorModelErrorsInner) IsSet() bool

func (NullableErrorModelErrorsInner) MarshalJSON 

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

func (*NullableErrorModelErrorsInner) Set 

func (v *NullableErrorModelErrorsInner) Set(val *ErrorModelErrorsInner)

func (*NullableErrorModelErrorsInner) UnmarshalJSON 

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

func (*NullableErrorModelErrorsInner) Unset 

func (v *NullableErrorModelErrorsInner) 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 NullableSlate 

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

func NewNullableSlate 

func NewNullableSlate(val *Slate) *NullableSlate

func (NullableSlate) Get 

func (v NullableSlate) Get() *Slate

func (NullableSlate) IsSet 

func (v NullableSlate) IsSet() bool

func (NullableSlate) MarshalJSON 

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

func (*NullableSlate) Set 

func (v *NullableSlate) Set(val *Slate)

func (*NullableSlate) UnmarshalJSON 

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

func (*NullableSlate) Unset 

func (v *NullableSlate) Unset()

type NullableSlate2 

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

func NewNullableSlate2 

func NewNullableSlate2(val *Slate2) *NullableSlate2

func (NullableSlate2) Get 

func (v NullableSlate2) Get() *Slate2

func (NullableSlate2) IsSet 

func (v NullableSlate2) IsSet() bool

func (NullableSlate2) MarshalJSON 

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

func (*NullableSlate2) Set 

func (v *NullableSlate2) Set(val *Slate2)

func (*NullableSlate2) UnmarshalJSON 

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

func (*NullableSlate2) Unset 

func (v *NullableSlate2) Unset()

type NullableSlateWithoutID 

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

func NewNullableSlateWithoutID 

func NewNullableSlateWithoutID(val *SlateWithoutID) *NullableSlateWithoutID

func (NullableSlateWithoutID) Get 

func (v NullableSlateWithoutID) Get() *SlateWithoutID

func (NullableSlateWithoutID) IsSet 

func (v NullableSlateWithoutID) IsSet() bool

func (NullableSlateWithoutID) MarshalJSON 

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

func (*NullableSlateWithoutID) Set 

func (v *NullableSlateWithoutID) Set(val *SlateWithoutID)

func (*NullableSlateWithoutID) UnmarshalJSON 

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

func (*NullableSlateWithoutID) Unset 

func (v *NullableSlateWithoutID) 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 ServerConfiguration 

type ServerConfiguration struct {
	URL         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerConfigurations 

type ServerConfigurations []ServerConfiguration

ServerConfigurations stores multiple ServerConfiguration items

func (ServerConfigurations) URL 

func (sc ServerConfigurations) URL(index int, variables map[string]string) (string, error)

URL formats template on a index using given variables

type ServerVariable 

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

type Slate 

type Slate struct {
	// An optional URL to a JSON Schema document describing this resource
	Schema *string `json:"$schema,omitempty" format:"uri" doc:"An optional URL to a JSON Schema document describing this resource"`
	// A friendly slate description.
	Description string `json:"description" doc:"A friendly slate description."`
	// Unique identifier for this slate
	Id string `json:"id" doc:"Unique identifier for this slate"`
	// The url where the slate can be accessed.
	Url string `json:"url" doc:"The url where the slate can be accessed."`
}

Slate struct for Slate

func NewSlate 

func NewSlate(description string, id string, url string) *Slate

NewSlate instantiates a new Slate 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 NewSlateWithDefaults 

func NewSlateWithDefaults() *Slate

NewSlateWithDefaults instantiates a new Slate 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 (*Slate) GetDescription 

func (o *Slate) GetDescription() string

GetDescription returns the Description field value

func (*Slate) GetDescriptionOk 

func (o *Slate) GetDescriptionOk() (*string, bool)

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

func (*Slate) GetId 

func (o *Slate) GetId() string

GetId returns the Id field value

func (*Slate) GetIdOk 

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

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

func (*Slate) GetSchema 

func (o *Slate) GetSchema() string

GetSchema returns the Schema field value if set, zero value otherwise.

func (*Slate) GetSchemaOk 

func (o *Slate) GetSchemaOk() (*string, bool)

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

func (*Slate) GetUrl 

func (o *Slate) GetUrl() string

GetUrl returns the Url field value

func (*Slate) GetUrlOk 

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

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

func (*Slate) HasSchema 

func (o *Slate) HasSchema() bool

HasSchema returns a boolean if a field has been set.

func (Slate) MarshalJSON 

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

func (*Slate) SetDescription 

func (o *Slate) SetDescription(v string)

SetDescription sets field value

func (*Slate) SetId 

func (o *Slate) SetId(v string)

SetId sets field value

func (*Slate) SetSchema 

func (o *Slate) SetSchema(v string)

SetSchema gets a reference to the given string and assigns it to the Schema field.

func (*Slate) SetUrl 

func (o *Slate) SetUrl(v string)

SetUrl sets field value

func (Slate) ToMap 

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

type Slate2 

type Slate2 struct {
	// A friendly slate description.
	Description string `json:"description" doc:"A friendly slate description."`
	// Unique identifier for this slate
	Id string `json:"id" doc:"Unique identifier for this slate"`
	// The url where the slate can be accessed.
	Url string `json:"url" doc:"The url where the slate can be accessed."`
}

Slate2 struct for Slate2

func NewSlate2 

func NewSlate2(description string, id string, url string) *Slate2

NewSlate2 instantiates a new Slate2 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 NewSlate2WithDefaults 

func NewSlate2WithDefaults() *Slate2

NewSlate2WithDefaults instantiates a new Slate2 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 (*Slate2) GetDescription 

func (o *Slate2) GetDescription() string

GetDescription returns the Description field value

func (*Slate2) GetDescriptionOk 

func (o *Slate2) GetDescriptionOk() (*string, bool)

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

func (*Slate2) GetId 

func (o *Slate2) GetId() string

GetId returns the Id field value

func (*Slate2) GetIdOk 

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

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

func (*Slate2) GetUrl 

func (o *Slate2) GetUrl() string

GetUrl returns the Url field value

func (*Slate2) GetUrlOk 

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

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

func (Slate2) MarshalJSON 

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

func (*Slate2) SetDescription 

func (o *Slate2) SetDescription(v string)

SetDescription sets field value

func (*Slate2) SetId 

func (o *Slate2) SetId(v string)

SetId sets field value

func (*Slate2) SetUrl 

func (o *Slate2) SetUrl(v string)

SetUrl sets field value

func (Slate2) ToMap 

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

type SlateWithoutID 

type SlateWithoutID struct {
	// An optional URL to a JSON Schema document describing this resource
	Schema *string `json:"$schema,omitempty" format:"uri" doc:"An optional URL to a JSON Schema document describing this resource"`
	// A friendly slate description.
	Description string `json:"description" doc:"A friendly slate description."`
	// The url where the slate can be accessed.
	Url string `json:"url" doc:"The url where the slate can be accessed."`
}

SlateWithoutID struct for SlateWithoutID

func NewSlateWithoutID 

func NewSlateWithoutID(description string, url string) *SlateWithoutID

NewSlateWithoutID instantiates a new SlateWithoutID 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 NewSlateWithoutIDWithDefaults 

func NewSlateWithoutIDWithDefaults() *SlateWithoutID

NewSlateWithoutIDWithDefaults instantiates a new SlateWithoutID 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 (*SlateWithoutID) GetDescription 

func (o *SlateWithoutID) GetDescription() string

GetDescription returns the Description field value

func (*SlateWithoutID) GetDescriptionOk 

func (o *SlateWithoutID) GetDescriptionOk() (*string, bool)

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

func (*SlateWithoutID) GetSchema 

func (o *SlateWithoutID) GetSchema() string

GetSchema returns the Schema field value if set, zero value otherwise.

func (*SlateWithoutID) GetSchemaOk 

func (o *SlateWithoutID) GetSchemaOk() (*string, bool)

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

func (*SlateWithoutID) GetUrl 

func (o *SlateWithoutID) GetUrl() string

GetUrl returns the Url field value

func (*SlateWithoutID) GetUrlOk 

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

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

func (*SlateWithoutID) HasSchema 

func (o *SlateWithoutID) HasSchema() bool

HasSchema returns a boolean if a field has been set.

func (SlateWithoutID) MarshalJSON 

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

func (*SlateWithoutID) SetDescription 

func (o *SlateWithoutID) SetDescription(v string)

SetDescription sets field value

func (*SlateWithoutID) SetSchema 

func (o *SlateWithoutID) SetSchema(v string)

SetSchema gets a reference to the given string and assigns it to the Schema field.

func (*SlateWithoutID) SetUrl 

func (o *SlateWithoutID) SetUrl(v string)

SetUrl sets field value

func (SlateWithoutID) ToMap 

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

type SlatesForOrganizationApi 

type SlatesForOrganizationApi interface {

	/*
		DeleteOrgSlate Delete Slate

		Delete a slate by id.

		@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		@param org Organization name
		@param slateId Unique identifier for this slate
		@return ApiDeleteOrgSlateRequest
	*/
	DeleteOrgSlate(ctx context.Context, org string, slateId string) ApiDeleteOrgSlateRequest

	// DeleteOrgSlateExecute executes the request
	DeleteOrgSlateExecute(r ApiDeleteOrgSlateRequest) (*http.Response, error)

	/*
		GetOrgSlate Get Slate

		Get a slate by id.

		@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		@param org Organization name
		@param slateId Unique identifier for this slate
		@return ApiGetOrgSlateRequest
	*/
	GetOrgSlate(ctx context.Context, org string, slateId string) ApiGetOrgSlateRequest

	// GetOrgSlateExecute executes the request
	//  @return Slate
	GetOrgSlateExecute(r ApiGetOrgSlateRequest) (*Slate, *http.Response, error)

	/*
		ListOrgSlates List Slates

		Returns a list of all slates.

		@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		@param org Organization name
		@return ApiListOrgSlatesRequest
	*/
	ListOrgSlates(ctx context.Context, org string) ApiListOrgSlatesRequest

	// ListOrgSlatesExecute executes the request
	//  @return []Slate2
	ListOrgSlatesExecute(r ApiListOrgSlatesRequest) ([]Slate2, *http.Response, error)

	/*
		PutOrgSlate Create/Update Slate

		Create or update a slate by id.  The URL of the slate must already exist.

		@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		@param org Organization name
		@param slateId Unique identifier for this slate
		@return ApiPutOrgSlateRequest
	*/
	PutOrgSlate(ctx context.Context, org string, slateId string) ApiPutOrgSlateRequest

	// PutOrgSlateExecute executes the request
	//  @return Slate
	PutOrgSlateExecute(r ApiPutOrgSlateRequest) (*Slate, *http.Response, error)
}

type SlatesForOrganizationApiService 

type SlatesForOrganizationApiService service

SlatesForOrganizationApiService SlatesForOrganizationApi service

func (*SlatesForOrganizationApiService) DeleteOrgSlate 

func (a *SlatesForOrganizationApiService) DeleteOrgSlate(ctx context.Context, org string, slateId string) ApiDeleteOrgSlateRequest

DeleteOrgSlate Delete Slate

Delete a slate by id. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param org Organization name
@param slateId Unique identifier for this slate
@return ApiDeleteOrgSlateRequest

func (*SlatesForOrganizationApiService) DeleteOrgSlateExecute 

func (a *SlatesForOrganizationApiService) DeleteOrgSlateExecute(r ApiDeleteOrgSlateRequest) (*http.Response, error)

Execute executes the request

func (*SlatesForOrganizationApiService) GetOrgSlate 

func (a *SlatesForOrganizationApiService) GetOrgSlate(ctx context.Context, org string, slateId string) ApiGetOrgSlateRequest

GetOrgSlate Get Slate

Get a slate by id. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param org Organization name
@param slateId Unique identifier for this slate
@return ApiGetOrgSlateRequest

func (*SlatesForOrganizationApiService) GetOrgSlateExecute 

func (a *SlatesForOrganizationApiService) GetOrgSlateExecute(r ApiGetOrgSlateRequest) (*Slate, *http.Response, error)

Execute executes the request 

@return Slate

func (*SlatesForOrganizationApiService) ListOrgSlates 

func (a *SlatesForOrganizationApiService) ListOrgSlates(ctx context.Context, org string) ApiListOrgSlatesRequest

ListOrgSlates List Slates

Returns a list of all slates. 

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

func (*SlatesForOrganizationApiService) ListOrgSlatesExecute 

func (a *SlatesForOrganizationApiService) ListOrgSlatesExecute(r ApiListOrgSlatesRequest) ([]Slate2, *http.Response, error)

Execute executes the request 

@return []Slate2

func (*SlatesForOrganizationApiService) PutOrgSlate 

func (a *SlatesForOrganizationApiService) PutOrgSlate(ctx context.Context, org string, slateId string) ApiPutOrgSlateRequest

PutOrgSlate Create/Update Slate

Create or update a slate by id. The URL of the slate must already exist. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param org Organization name
@param slateId Unique identifier for this slate
@return ApiPutOrgSlateRequest

func (*SlatesForOrganizationApiService) PutOrgSlateExecute 

func (a *SlatesForOrganizationApiService) PutOrgSlateExecute(r ApiPutOrgSlateRequest) (*Slate, *http.Response, error)

Execute executes the request 

@return Slate

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.