owners

package
v0.0.0-...-abe38a1 Latest Latest
Warning

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

Go to latest
Published: Feb 3, 2024 License: MIT Imports: 23 Imported by: 3

README

Go API client for owners

HubSpot uses owners to assign CRM objects to specific people in your organization. The endpoints described here are used to get a list of the owners that are available for an account. To assign an owner to an object, set the hubspot_owner_id property using the appropriate CRM object update or create a request.

If teams are available for your HubSpot tier, these endpoints will also indicate which team(s) an owner can access, as well as which team is the owner's primary team.

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

ctx := context.WithValue(context.Background(), owners.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(), owners.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), owners.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), owners.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
OwnersApi GetByID Get /crm/v3/owners/{ownerId} Read an owner by given `id` or `userId`
OwnersApi GetPage Get /crm/v3/owners/ Get a page of owners

Documentation For Models

Documentation For Authorization

oauth2

Example

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

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

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.

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

APIClient manages communication with the Crm Owners 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 ApiGetByIDRequest

type ApiGetByIDRequest struct {
	ApiService *OwnersApiService
	// contains filtered or unexported fields
}

func (ApiGetByIDRequest) Archived

func (r ApiGetByIDRequest) Archived(archived bool) ApiGetByIDRequest

Whether to return only results that have been archived.

func (ApiGetByIDRequest) Execute

func (r ApiGetByIDRequest) Execute() (*PublicOwner, *http.Response, error)

func (ApiGetByIDRequest) IdProperty

func (r ApiGetByIDRequest) IdProperty(idProperty string) ApiGetByIDRequest

type ApiGetPageRequest

type ApiGetPageRequest struct {
	ApiService *OwnersApiService
	// contains filtered or unexported fields
}

func (ApiGetPageRequest) After

The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.

func (ApiGetPageRequest) Archived

func (r ApiGetPageRequest) Archived(archived bool) ApiGetPageRequest

Whether to return only results that have been archived.

func (ApiGetPageRequest) Email

Filter by email address (optional)

func (ApiGetPageRequest) Execute

func (ApiGetPageRequest) Limit

func (r ApiGetPageRequest) Limit(limit int32) ApiGetPageRequest

The maximum number of results to display per page.

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 CollectionResponsePublicOwnerForwardPaging

type CollectionResponsePublicOwnerForwardPaging struct {
	Paging  *ForwardPaging `json:"paging,omitempty"`
	Results []PublicOwner  `json:"results"`
}

CollectionResponsePublicOwnerForwardPaging struct for CollectionResponsePublicOwnerForwardPaging

func NewCollectionResponsePublicOwnerForwardPaging

func NewCollectionResponsePublicOwnerForwardPaging(results []PublicOwner) *CollectionResponsePublicOwnerForwardPaging

NewCollectionResponsePublicOwnerForwardPaging instantiates a new CollectionResponsePublicOwnerForwardPaging 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 NewCollectionResponsePublicOwnerForwardPagingWithDefaults

func NewCollectionResponsePublicOwnerForwardPagingWithDefaults() *CollectionResponsePublicOwnerForwardPaging

NewCollectionResponsePublicOwnerForwardPagingWithDefaults instantiates a new CollectionResponsePublicOwnerForwardPaging 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 (*CollectionResponsePublicOwnerForwardPaging) GetPaging

GetPaging returns the Paging field value if set, zero value otherwise.

func (*CollectionResponsePublicOwnerForwardPaging) GetPagingOk

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

func (*CollectionResponsePublicOwnerForwardPaging) GetResults

GetResults returns the Results field value

func (*CollectionResponsePublicOwnerForwardPaging) GetResultsOk

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

func (*CollectionResponsePublicOwnerForwardPaging) HasPaging

HasPaging returns a boolean if a field has been set.

func (CollectionResponsePublicOwnerForwardPaging) MarshalJSON

func (*CollectionResponsePublicOwnerForwardPaging) SetPaging

SetPaging gets a reference to the given ForwardPaging and assigns it to the Paging field.

func (*CollectionResponsePublicOwnerForwardPaging) SetResults

SetResults sets field value

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.

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.

type ForwardPaging

type ForwardPaging struct {
	Next *NextPage `json:"next,omitempty"`
}

ForwardPaging struct for ForwardPaging

func NewForwardPaging

func NewForwardPaging() *ForwardPaging

NewForwardPaging instantiates a new ForwardPaging 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 NewForwardPagingWithDefaults

func NewForwardPagingWithDefaults() *ForwardPaging

NewForwardPagingWithDefaults instantiates a new ForwardPaging 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 (*ForwardPaging) GetNext

func (o *ForwardPaging) GetNext() NextPage

GetNext returns the Next field value if set, zero value otherwise.

func (*ForwardPaging) GetNextOk

func (o *ForwardPaging) GetNextOk() (*NextPage, bool)

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

func (*ForwardPaging) HasNext

func (o *ForwardPaging) HasNext() bool

HasNext returns a boolean if a field has been set.

func (ForwardPaging) MarshalJSON

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

func (*ForwardPaging) SetNext

func (o *ForwardPaging) SetNext(v NextPage)

SetNext gets a reference to the given NextPage and assigns it to the Next field.

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 NextPage

type NextPage struct {
	Link  *string `json:"link,omitempty"`
	After string  `json:"after"`
}

NextPage struct for NextPage

func NewNextPage

func NewNextPage(after string) *NextPage

NewNextPage instantiates a new NextPage 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 NewNextPageWithDefaults

func NewNextPageWithDefaults() *NextPage

NewNextPageWithDefaults instantiates a new NextPage 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 (*NextPage) GetAfter

func (o *NextPage) GetAfter() string

GetAfter returns the After field value

func (*NextPage) GetAfterOk

func (o *NextPage) GetAfterOk() (*string, bool)

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

func (o *NextPage) GetLink() string

GetLink returns the Link field value if set, zero value otherwise.

func (*NextPage) GetLinkOk

func (o *NextPage) GetLinkOk() (*string, bool)

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

func (o *NextPage) HasLink() bool

HasLink returns a boolean if a field has been set.

func (NextPage) MarshalJSON

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

func (*NextPage) SetAfter

func (o *NextPage) SetAfter(v string)

SetAfter sets field value

func (o *NextPage) SetLink(v string)

SetLink gets a reference to the given string and assigns it to the Link field.

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 NullableCollectionResponsePublicOwnerForwardPaging

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

func (NullableCollectionResponsePublicOwnerForwardPaging) Get

func (NullableCollectionResponsePublicOwnerForwardPaging) IsSet

func (NullableCollectionResponsePublicOwnerForwardPaging) MarshalJSON

func (*NullableCollectionResponsePublicOwnerForwardPaging) Set

func (*NullableCollectionResponsePublicOwnerForwardPaging) UnmarshalJSON

func (*NullableCollectionResponsePublicOwnerForwardPaging) 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 (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 NullableForwardPaging

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

func NewNullableForwardPaging

func NewNullableForwardPaging(val *ForwardPaging) *NullableForwardPaging

func (NullableForwardPaging) Get

func (NullableForwardPaging) IsSet

func (v NullableForwardPaging) IsSet() bool

func (NullableForwardPaging) MarshalJSON

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

func (*NullableForwardPaging) Set

func (v *NullableForwardPaging) Set(val *ForwardPaging)

func (*NullableForwardPaging) UnmarshalJSON

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

func (*NullableForwardPaging) Unset

func (v *NullableForwardPaging) 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 NullableNextPage

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

func NewNullableNextPage

func NewNullableNextPage(val *NextPage) *NullableNextPage

func (NullableNextPage) Get

func (v NullableNextPage) Get() *NextPage

func (NullableNextPage) IsSet

func (v NullableNextPage) IsSet() bool

func (NullableNextPage) MarshalJSON

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

func (*NullableNextPage) Set

func (v *NullableNextPage) Set(val *NextPage)

func (*NullableNextPage) UnmarshalJSON

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

func (*NullableNextPage) Unset

func (v *NullableNextPage) Unset()

type NullablePublicOwner

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

func NewNullablePublicOwner

func NewNullablePublicOwner(val *PublicOwner) *NullablePublicOwner

func (NullablePublicOwner) Get

func (NullablePublicOwner) IsSet

func (v NullablePublicOwner) IsSet() bool

func (NullablePublicOwner) MarshalJSON

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

func (*NullablePublicOwner) Set

func (v *NullablePublicOwner) Set(val *PublicOwner)

func (*NullablePublicOwner) UnmarshalJSON

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

func (*NullablePublicOwner) Unset

func (v *NullablePublicOwner) Unset()

type NullablePublicTeam

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

func NewNullablePublicTeam

func NewNullablePublicTeam(val *PublicTeam) *NullablePublicTeam

func (NullablePublicTeam) Get

func (v NullablePublicTeam) Get() *PublicTeam

func (NullablePublicTeam) IsSet

func (v NullablePublicTeam) IsSet() bool

func (NullablePublicTeam) MarshalJSON

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

func (*NullablePublicTeam) Set

func (v *NullablePublicTeam) Set(val *PublicTeam)

func (*NullablePublicTeam) UnmarshalJSON

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

func (*NullablePublicTeam) Unset

func (v *NullablePublicTeam) 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 OwnersApiService

type OwnersApiService service

OwnersApiService OwnersApi service

func (*OwnersApiService) GetByID

func (a *OwnersApiService) GetByID(ctx context.Context, ownerId int32) ApiGetByIDRequest

GetByID Read an owner by given `id` or `userId`

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

func (*OwnersApiService) GetByIDExecute

func (a *OwnersApiService) GetByIDExecute(r ApiGetByIDRequest) (*PublicOwner, *http.Response, error)

Execute executes the request

@return PublicOwner

func (*OwnersApiService) GetPage

GetPage Get a page of owners

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

func (*OwnersApiService) GetPageExecute

Execute executes the request

@return CollectionResponsePublicOwnerForwardPaging

type PublicOwner

type PublicOwner struct {
	FirstName *string      `json:"firstName,omitempty"`
	LastName  *string      `json:"lastName,omitempty"`
	CreatedAt time.Time    `json:"createdAt"`
	Archived  bool         `json:"archived"`
	Teams     []PublicTeam `json:"teams,omitempty"`
	Id        string       `json:"id"`
	UserId    *int32       `json:"userId,omitempty"`
	Email     *string      `json:"email,omitempty"`
	UpdatedAt time.Time    `json:"updatedAt"`
}

PublicOwner struct for PublicOwner

func NewPublicOwner

func NewPublicOwner(createdAt time.Time, archived bool, id string, updatedAt time.Time) *PublicOwner

NewPublicOwner instantiates a new PublicOwner 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 NewPublicOwnerWithDefaults

func NewPublicOwnerWithDefaults() *PublicOwner

NewPublicOwnerWithDefaults instantiates a new PublicOwner 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 (*PublicOwner) GetArchived

func (o *PublicOwner) GetArchived() bool

GetArchived returns the Archived field value

func (*PublicOwner) GetArchivedOk

func (o *PublicOwner) GetArchivedOk() (*bool, bool)

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

func (*PublicOwner) GetCreatedAt

func (o *PublicOwner) GetCreatedAt() time.Time

GetCreatedAt returns the CreatedAt field value

func (*PublicOwner) GetCreatedAtOk

func (o *PublicOwner) GetCreatedAtOk() (*time.Time, bool)

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

func (*PublicOwner) GetEmail

func (o *PublicOwner) GetEmail() string

GetEmail returns the Email field value if set, zero value otherwise.

func (*PublicOwner) GetEmailOk

func (o *PublicOwner) GetEmailOk() (*string, bool)

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

func (*PublicOwner) GetFirstName

func (o *PublicOwner) GetFirstName() string

GetFirstName returns the FirstName field value if set, zero value otherwise.

func (*PublicOwner) GetFirstNameOk

func (o *PublicOwner) GetFirstNameOk() (*string, bool)

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

func (*PublicOwner) GetId

func (o *PublicOwner) GetId() string

GetId returns the Id field value

func (*PublicOwner) GetIdOk

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

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

func (*PublicOwner) GetLastName

func (o *PublicOwner) GetLastName() string

GetLastName returns the LastName field value if set, zero value otherwise.

func (*PublicOwner) GetLastNameOk

func (o *PublicOwner) GetLastNameOk() (*string, bool)

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

func (*PublicOwner) GetTeams

func (o *PublicOwner) GetTeams() []PublicTeam

GetTeams returns the Teams field value if set, zero value otherwise.

func (*PublicOwner) GetTeamsOk

func (o *PublicOwner) GetTeamsOk() ([]PublicTeam, bool)

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

func (*PublicOwner) GetUpdatedAt

func (o *PublicOwner) GetUpdatedAt() time.Time

GetUpdatedAt returns the UpdatedAt field value

func (*PublicOwner) GetUpdatedAtOk

func (o *PublicOwner) GetUpdatedAtOk() (*time.Time, bool)

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

func (*PublicOwner) GetUserId

func (o *PublicOwner) GetUserId() int32

GetUserId returns the UserId field value if set, zero value otherwise.

func (*PublicOwner) GetUserIdOk

func (o *PublicOwner) GetUserIdOk() (*int32, bool)

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

func (*PublicOwner) HasEmail

func (o *PublicOwner) HasEmail() bool

HasEmail returns a boolean if a field has been set.

func (*PublicOwner) HasFirstName

func (o *PublicOwner) HasFirstName() bool

HasFirstName returns a boolean if a field has been set.

func (*PublicOwner) HasLastName

func (o *PublicOwner) HasLastName() bool

HasLastName returns a boolean if a field has been set.

func (*PublicOwner) HasTeams

func (o *PublicOwner) HasTeams() bool

HasTeams returns a boolean if a field has been set.

func (*PublicOwner) HasUserId

func (o *PublicOwner) HasUserId() bool

HasUserId returns a boolean if a field has been set.

func (PublicOwner) MarshalJSON

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

func (*PublicOwner) SetArchived

func (o *PublicOwner) SetArchived(v bool)

SetArchived sets field value

func (*PublicOwner) SetCreatedAt

func (o *PublicOwner) SetCreatedAt(v time.Time)

SetCreatedAt sets field value

func (*PublicOwner) SetEmail

func (o *PublicOwner) SetEmail(v string)

SetEmail gets a reference to the given string and assigns it to the Email field.

func (*PublicOwner) SetFirstName

func (o *PublicOwner) SetFirstName(v string)

SetFirstName gets a reference to the given string and assigns it to the FirstName field.

func (*PublicOwner) SetId

func (o *PublicOwner) SetId(v string)

SetId sets field value

func (*PublicOwner) SetLastName

func (o *PublicOwner) SetLastName(v string)

SetLastName gets a reference to the given string and assigns it to the LastName field.

func (*PublicOwner) SetTeams

func (o *PublicOwner) SetTeams(v []PublicTeam)

SetTeams gets a reference to the given []PublicTeam and assigns it to the Teams field.

func (*PublicOwner) SetUpdatedAt

func (o *PublicOwner) SetUpdatedAt(v time.Time)

SetUpdatedAt sets field value

func (*PublicOwner) SetUserId

func (o *PublicOwner) SetUserId(v int32)

SetUserId gets a reference to the given int32 and assigns it to the UserId field.

type PublicTeam

type PublicTeam struct {
	Name    string `json:"name"`
	Id      string `json:"id"`
	Primary bool   `json:"primary"`
}

PublicTeam struct for PublicTeam

func NewPublicTeam

func NewPublicTeam(name string, id string, primary bool) *PublicTeam

NewPublicTeam instantiates a new PublicTeam 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 NewPublicTeamWithDefaults

func NewPublicTeamWithDefaults() *PublicTeam

NewPublicTeamWithDefaults instantiates a new PublicTeam 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 (*PublicTeam) GetId

func (o *PublicTeam) GetId() string

GetId returns the Id field value

func (*PublicTeam) GetIdOk

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

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

func (*PublicTeam) GetName

func (o *PublicTeam) GetName() string

GetName returns the Name field value

func (*PublicTeam) GetNameOk

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

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

func (*PublicTeam) GetPrimary

func (o *PublicTeam) GetPrimary() bool

GetPrimary returns the Primary field value

func (*PublicTeam) GetPrimaryOk

func (o *PublicTeam) GetPrimaryOk() (*bool, bool)

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

func (PublicTeam) MarshalJSON

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

func (*PublicTeam) SetId

func (o *PublicTeam) SetId(v string)

SetId sets field value

func (*PublicTeam) SetName

func (o *PublicTeam) SetName(v string)

SetName sets field value

func (*PublicTeam) SetPrimary

func (o *PublicTeam) SetPrimary(v bool)

SetPrimary 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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL