pipelines

package
v0.1.3 Latest Latest
Warning

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

 Go to latest Published: Apr 24, 2023 License: MIT Imports: 23 Imported by: 0

README

Go API client for pipelines

Pipelines represent distinct stages in a workflow, like closing a deal or servicing a support ticket. These endpoints provide access to read and modify pipelines in HubSpot. Pipelines support deals and tickets object types.

Pipeline ID validation

When calling endpoints that take pipelineId as a parameter, that ID must correspond to an existing, un-archived pipeline. Otherwise the request will fail with a 404 Not Found response.

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 pipelines "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(), pipelines.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(), pipelines.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(), pipelines.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), pipelines.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
PipelineAuditsApi GetAudit Get /crm/v3/pipelines/{objectType}/{pipelineId}/audit Return an audit of all changes to the pipeline
PipelineStageAuditsApi StagesGetAudit Get /crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}/audit Return an audit of all changes to the pipeline stage
PipelineStagesApi StagesArchive Delete /crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId} Delete a pipeline stage
PipelineStagesApi StagesCreate Post /crm/v3/pipelines/{objectType}/{pipelineId}/stages Create a pipeline stage
PipelineStagesApi StagesGetAll Get /crm/v3/pipelines/{objectType}/{pipelineId}/stages Return all stages of a pipeline
PipelineStagesApi StagesGetByID Get /crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId} Return a pipeline stage by ID
PipelineStagesApi StagesReplace Put /crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId} Replace a pipeline stage
PipelineStagesApi StagesUpdate Patch /crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId} Update a pipeline stage
PipelinesApi Archive Delete /crm/v3/pipelines/{objectType}/{pipelineId} Delete a pipeline
PipelinesApi Create Post /crm/v3/pipelines/{objectType} Create a pipeline
PipelinesApi GetAll Get /crm/v3/pipelines/{objectType} Retrieve all pipelines
PipelinesApi GetByID Get /crm/v3/pipelines/{objectType}/{pipelineId} Return a pipeline by ID
PipelinesApi Replace Put /crm/v3/pipelines/{objectType}/{pipelineId} Replace a pipeline
PipelinesApi Update Patch /crm/v3/pipelines/{objectType}/{pipelineId} Update a pipeline

Documentation For Models

Documentation For Authorization

hapikey
  • Type: API key
  • API key parameter name: hapikey
  • Location: URL query string

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

oauth2
  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: https://app.hubspot.com/oauth/authorize
  • Scopes:
  • crm.objects.contacts.read:
  • crm.schemas.quotes.read: Quotes schemas
  • crm.objects.contacts.write:
  • crm.schemas.contacts.read:
  • crm.objects.companies.write:
  • crm.objects.companies.read:
  • crm.schemas.companies.read:
  • crm.objects.deals.read:
  • crm.schemas.line_items.read: Line Items schemas
  • crm.objects.deals.write:
  • crm.schemas.deals.read:
  • crm.schemas.deals.write:
  • crm.schemas.contacts.write:
  • crm.schemas.companies.write:

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)
oauth2_legacy
  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: https://app.hubspot.com/oauth/authorize
  • Scopes:
  • timeline: Create timeline events
  • tickets: Read and write tickets
  • media_bridge.read: Read media and media events
  • crm.schemas.custom.read: View custom object definitions
  • e-commerce: e-commerce

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 {
	PipelineAuditsApi *PipelineAuditsApiService

	PipelineStageAuditsApi *PipelineStageAuditsApiService

	PipelineStagesApi *PipelineStagesApiService

	PipelinesApi *PipelinesApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the CRM Pipelines 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 ApiArchiveRequest 

type ApiArchiveRequest struct {
	ApiService *PipelinesApiService
	// contains filtered or unexported fields
}

func (ApiArchiveRequest) Execute 

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

func (ApiArchiveRequest) ValidateReferencesBeforeDelete 

func (r ApiArchiveRequest) ValidateReferencesBeforeDelete(validateReferencesBeforeDelete bool) ApiArchiveRequest

type ApiCreateRequest 

type ApiCreateRequest struct {
	ApiService *PipelinesApiService
	// contains filtered or unexported fields
}

func (ApiCreateRequest) Execute 

func (r ApiCreateRequest) Execute() (*Pipeline, *http.Response, error)

func (ApiCreateRequest) PipelineInput 

func (r ApiCreateRequest) PipelineInput(pipelineInput PipelineInput) ApiCreateRequest

type ApiGetAllRequest 

type ApiGetAllRequest struct {
	ApiService *PipelinesApiService
	// contains filtered or unexported fields
}

func (ApiGetAllRequest) Execute 

func (r ApiGetAllRequest) Execute() (*CollectionResponsePipelineNoPaging, *http.Response, error)

type ApiGetAuditRequest 

type ApiGetAuditRequest struct {
	ApiService *PipelineAuditsApiService
	// contains filtered or unexported fields
}

func (ApiGetAuditRequest) Execute 

func (r ApiGetAuditRequest) Execute() (*CollectionResponsePublicAuditInfoNoPaging, *http.Response, error)

type ApiGetByIDRequest 

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

func (ApiGetByIDRequest) Execute 

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

type ApiReplaceRequest 

type ApiReplaceRequest struct {
	ApiService *PipelinesApiService
	// contains filtered or unexported fields
}

func (ApiReplaceRequest) Execute 

func (r ApiReplaceRequest) Execute() (*Pipeline, *http.Response, error)

func (ApiReplaceRequest) PipelineInput 

func (r ApiReplaceRequest) PipelineInput(pipelineInput PipelineInput) ApiReplaceRequest

func (ApiReplaceRequest) ValidateReferencesBeforeDelete 

func (r ApiReplaceRequest) ValidateReferencesBeforeDelete(validateReferencesBeforeDelete bool) ApiReplaceRequest

type ApiStagesArchiveRequest 

type ApiStagesArchiveRequest struct {
	ApiService *PipelineStagesApiService
	// contains filtered or unexported fields
}

func (ApiStagesArchiveRequest) Execute 

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

type ApiStagesCreateRequest 

type ApiStagesCreateRequest struct {
	ApiService *PipelineStagesApiService
	// contains filtered or unexported fields
}

func (ApiStagesCreateRequest) Execute 

func (r ApiStagesCreateRequest) Execute() (*PipelineStage, *http.Response, error)

func (ApiStagesCreateRequest) PipelineStageInput 

func (r ApiStagesCreateRequest) PipelineStageInput(pipelineStageInput PipelineStageInput) ApiStagesCreateRequest

type ApiStagesGetAllRequest 

type ApiStagesGetAllRequest struct {
	ApiService *PipelineStagesApiService
	// contains filtered or unexported fields
}

func (ApiStagesGetAllRequest) Execute 

func (r ApiStagesGetAllRequest) Execute() (*CollectionResponsePipelineStageNoPaging, *http.Response, error)

type ApiStagesGetAuditRequest 

type ApiStagesGetAuditRequest struct {
	ApiService *PipelineStageAuditsApiService
	// contains filtered or unexported fields
}

func (ApiStagesGetAuditRequest) Execute 

func (r ApiStagesGetAuditRequest) Execute() (*CollectionResponsePublicAuditInfoNoPaging, *http.Response, error)

type ApiStagesGetByIDRequest 

type ApiStagesGetByIDRequest struct {
	ApiService *PipelineStagesApiService
	// contains filtered or unexported fields
}

func (ApiStagesGetByIDRequest) Execute 

func (r ApiStagesGetByIDRequest) Execute() (*PipelineStage, *http.Response, error)

type ApiStagesReplaceRequest 

type ApiStagesReplaceRequest struct {
	ApiService *PipelineStagesApiService
	// contains filtered or unexported fields
}

func (ApiStagesReplaceRequest) Execute 

func (r ApiStagesReplaceRequest) Execute() (*PipelineStage, *http.Response, error)

func (ApiStagesReplaceRequest) PipelineStageInput 

func (r ApiStagesReplaceRequest) PipelineStageInput(pipelineStageInput PipelineStageInput) ApiStagesReplaceRequest

type ApiStagesUpdateRequest 

type ApiStagesUpdateRequest struct {
	ApiService *PipelineStagesApiService
	// contains filtered or unexported fields
}

func (ApiStagesUpdateRequest) Execute 

func (r ApiStagesUpdateRequest) Execute() (*PipelineStage, *http.Response, error)

func (ApiStagesUpdateRequest) PipelineStagePatchInput 

func (r ApiStagesUpdateRequest) PipelineStagePatchInput(pipelineStagePatchInput PipelineStagePatchInput) ApiStagesUpdateRequest

type ApiUpdateRequest 

type ApiUpdateRequest struct {
	ApiService *PipelinesApiService
	// contains filtered or unexported fields
}

func (ApiUpdateRequest) Execute 

func (r ApiUpdateRequest) Execute() (*Pipeline, *http.Response, error)

func (ApiUpdateRequest) PipelinePatchInput 

func (r ApiUpdateRequest) PipelinePatchInput(pipelinePatchInput PipelinePatchInput) ApiUpdateRequest

func (ApiUpdateRequest) ValidateReferencesBeforeDelete 

func (r ApiUpdateRequest) ValidateReferencesBeforeDelete(validateReferencesBeforeDelete bool) ApiUpdateRequest

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 CollectionResponsePipelineNoPaging 

type CollectionResponsePipelineNoPaging struct {
	Results []Pipeline `json:"results"`
}

CollectionResponsePipelineNoPaging struct for CollectionResponsePipelineNoPaging

func NewCollectionResponsePipelineNoPaging 

func NewCollectionResponsePipelineNoPaging(results []Pipeline) *CollectionResponsePipelineNoPaging

NewCollectionResponsePipelineNoPaging instantiates a new CollectionResponsePipelineNoPaging 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 NewCollectionResponsePipelineNoPagingWithDefaults 

func NewCollectionResponsePipelineNoPagingWithDefaults() *CollectionResponsePipelineNoPaging

NewCollectionResponsePipelineNoPagingWithDefaults instantiates a new CollectionResponsePipelineNoPaging 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 (*CollectionResponsePipelineNoPaging) GetResults 

func (o *CollectionResponsePipelineNoPaging) GetResults() []Pipeline

GetResults returns the Results field value

func (*CollectionResponsePipelineNoPaging) GetResultsOk 

func (o *CollectionResponsePipelineNoPaging) GetResultsOk() ([]Pipeline, bool)

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

func (CollectionResponsePipelineNoPaging) MarshalJSON 

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

func (*CollectionResponsePipelineNoPaging) SetResults 

func (o *CollectionResponsePipelineNoPaging) SetResults(v []Pipeline)

SetResults sets field value

type CollectionResponsePipelineStageNoPaging 

type CollectionResponsePipelineStageNoPaging struct {
	Results []PipelineStage `json:"results"`
}

CollectionResponsePipelineStageNoPaging struct for CollectionResponsePipelineStageNoPaging

func NewCollectionResponsePipelineStageNoPaging 

func NewCollectionResponsePipelineStageNoPaging(results []PipelineStage) *CollectionResponsePipelineStageNoPaging

NewCollectionResponsePipelineStageNoPaging instantiates a new CollectionResponsePipelineStageNoPaging 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 NewCollectionResponsePipelineStageNoPagingWithDefaults 

func NewCollectionResponsePipelineStageNoPagingWithDefaults() *CollectionResponsePipelineStageNoPaging

NewCollectionResponsePipelineStageNoPagingWithDefaults instantiates a new CollectionResponsePipelineStageNoPaging 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 (*CollectionResponsePipelineStageNoPaging) GetResults 

func (o *CollectionResponsePipelineStageNoPaging) GetResults() []PipelineStage

GetResults returns the Results field value

func (*CollectionResponsePipelineStageNoPaging) GetResultsOk 

func (o *CollectionResponsePipelineStageNoPaging) GetResultsOk() ([]PipelineStage, bool)

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

func (CollectionResponsePipelineStageNoPaging) MarshalJSON 

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

func (*CollectionResponsePipelineStageNoPaging) SetResults 

func (o *CollectionResponsePipelineStageNoPaging) SetResults(v []PipelineStage)

SetResults sets field value

type CollectionResponsePublicAuditInfoNoPaging 

type CollectionResponsePublicAuditInfoNoPaging struct {
	Results []PublicAuditInfo `json:"results"`
}

CollectionResponsePublicAuditInfoNoPaging struct for CollectionResponsePublicAuditInfoNoPaging

func NewCollectionResponsePublicAuditInfoNoPaging 

func NewCollectionResponsePublicAuditInfoNoPaging(results []PublicAuditInfo) *CollectionResponsePublicAuditInfoNoPaging

NewCollectionResponsePublicAuditInfoNoPaging instantiates a new CollectionResponsePublicAuditInfoNoPaging 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 NewCollectionResponsePublicAuditInfoNoPagingWithDefaults 

func NewCollectionResponsePublicAuditInfoNoPagingWithDefaults() *CollectionResponsePublicAuditInfoNoPaging

NewCollectionResponsePublicAuditInfoNoPagingWithDefaults instantiates a new CollectionResponsePublicAuditInfoNoPaging 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 (*CollectionResponsePublicAuditInfoNoPaging) GetResults 

func (o *CollectionResponsePublicAuditInfoNoPaging) GetResults() []PublicAuditInfo

GetResults returns the Results field value

func (*CollectionResponsePublicAuditInfoNoPaging) GetResultsOk 

func (o *CollectionResponsePublicAuditInfoNoPaging) GetResultsOk() ([]PublicAuditInfo, bool)

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

func (CollectionResponsePublicAuditInfoNoPaging) MarshalJSON 

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

func (*CollectionResponsePublicAuditInfoNoPaging) SetResults 

func (o *CollectionResponsePublicAuditInfoNoPaging) SetResults(v []PublicAuditInfo)

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

Error struct for Error

func NewError 

func NewError(message string, correlationId 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 human readable message describing the error along with remediation steps where appropriate
	Message string `json:"message"`
	// The name of the field or parameter in which the error was found.
	In *string `json:"in,omitempty"`
	// The status code associated with the error detail
	Code *string `json:"code,omitempty"`
	// 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"`
}

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

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

func NewNullableCollectionResponsePipelineNoPaging 

func NewNullableCollectionResponsePipelineNoPaging(val *CollectionResponsePipelineNoPaging) *NullableCollectionResponsePipelineNoPaging

func (NullableCollectionResponsePipelineNoPaging) Get 

func (v NullableCollectionResponsePipelineNoPaging) Get() *CollectionResponsePipelineNoPaging

func (NullableCollectionResponsePipelineNoPaging) IsSet 

func (v NullableCollectionResponsePipelineNoPaging) IsSet() bool

func (NullableCollectionResponsePipelineNoPaging) MarshalJSON 

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

func (*NullableCollectionResponsePipelineNoPaging) Set 

func (v *NullableCollectionResponsePipelineNoPaging) Set(val *CollectionResponsePipelineNoPaging)

func (*NullableCollectionResponsePipelineNoPaging) UnmarshalJSON 

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

func (*NullableCollectionResponsePipelineNoPaging) Unset 

func (v *NullableCollectionResponsePipelineNoPaging) Unset()

type NullableCollectionResponsePipelineStageNoPaging 

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

func NewNullableCollectionResponsePipelineStageNoPaging 

func NewNullableCollectionResponsePipelineStageNoPaging(val *CollectionResponsePipelineStageNoPaging) *NullableCollectionResponsePipelineStageNoPaging

func (NullableCollectionResponsePipelineStageNoPaging) Get 

func (v NullableCollectionResponsePipelineStageNoPaging) Get() *CollectionResponsePipelineStageNoPaging

func (NullableCollectionResponsePipelineStageNoPaging) IsSet 

func (v NullableCollectionResponsePipelineStageNoPaging) IsSet() bool

func (NullableCollectionResponsePipelineStageNoPaging) MarshalJSON 

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

func (*NullableCollectionResponsePipelineStageNoPaging) Set 

func (v *NullableCollectionResponsePipelineStageNoPaging) Set(val *CollectionResponsePipelineStageNoPaging)

func (*NullableCollectionResponsePipelineStageNoPaging) UnmarshalJSON 

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

func (*NullableCollectionResponsePipelineStageNoPaging) Unset 

func (v *NullableCollectionResponsePipelineStageNoPaging) Unset()

type NullableCollectionResponsePublicAuditInfoNoPaging 

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

func NewNullableCollectionResponsePublicAuditInfoNoPaging 

func NewNullableCollectionResponsePublicAuditInfoNoPaging(val *CollectionResponsePublicAuditInfoNoPaging) *NullableCollectionResponsePublicAuditInfoNoPaging

func (NullableCollectionResponsePublicAuditInfoNoPaging) Get 

func (v NullableCollectionResponsePublicAuditInfoNoPaging) Get() *CollectionResponsePublicAuditInfoNoPaging

func (NullableCollectionResponsePublicAuditInfoNoPaging) IsSet 

func (v NullableCollectionResponsePublicAuditInfoNoPaging) IsSet() bool

func (NullableCollectionResponsePublicAuditInfoNoPaging) MarshalJSON 

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

func (*NullableCollectionResponsePublicAuditInfoNoPaging) Set 

func (v *NullableCollectionResponsePublicAuditInfoNoPaging) Set(val *CollectionResponsePublicAuditInfoNoPaging)

func (*NullableCollectionResponsePublicAuditInfoNoPaging) UnmarshalJSON 

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

func (*NullableCollectionResponsePublicAuditInfoNoPaging) Unset 

func (v *NullableCollectionResponsePublicAuditInfoNoPaging) 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 NullablePipeline 

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

func NewNullablePipeline 

func NewNullablePipeline(val *Pipeline) *NullablePipeline

func (NullablePipeline) Get 

func (v NullablePipeline) Get() *Pipeline

func (NullablePipeline) IsSet 

func (v NullablePipeline) IsSet() bool

func (NullablePipeline) MarshalJSON 

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

func (*NullablePipeline) Set 

func (v *NullablePipeline) Set(val *Pipeline)

func (*NullablePipeline) UnmarshalJSON 

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

func (*NullablePipeline) Unset 

func (v *NullablePipeline) Unset()

type NullablePipelineInput 

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

func NewNullablePipelineInput 

func NewNullablePipelineInput(val *PipelineInput) *NullablePipelineInput

func (NullablePipelineInput) Get 

func (v NullablePipelineInput) Get() *PipelineInput

func (NullablePipelineInput) IsSet 

func (v NullablePipelineInput) IsSet() bool

func (NullablePipelineInput) MarshalJSON 

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

func (*NullablePipelineInput) Set 

func (v *NullablePipelineInput) Set(val *PipelineInput)

func (*NullablePipelineInput) UnmarshalJSON 

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

func (*NullablePipelineInput) Unset 

func (v *NullablePipelineInput) Unset()

type NullablePipelinePatchInput 

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

func NewNullablePipelinePatchInput 

func NewNullablePipelinePatchInput(val *PipelinePatchInput) *NullablePipelinePatchInput

func (NullablePipelinePatchInput) Get 

func (v NullablePipelinePatchInput) Get() *PipelinePatchInput

func (NullablePipelinePatchInput) IsSet 

func (v NullablePipelinePatchInput) IsSet() bool

func (NullablePipelinePatchInput) MarshalJSON 

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

func (*NullablePipelinePatchInput) Set 

func (v *NullablePipelinePatchInput) Set(val *PipelinePatchInput)

func (*NullablePipelinePatchInput) UnmarshalJSON 

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

func (*NullablePipelinePatchInput) Unset 

func (v *NullablePipelinePatchInput) Unset()

type NullablePipelineStage 

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

func NewNullablePipelineStage 

func NewNullablePipelineStage(val *PipelineStage) *NullablePipelineStage

func (NullablePipelineStage) Get 

func (v NullablePipelineStage) Get() *PipelineStage

func (NullablePipelineStage) IsSet 

func (v NullablePipelineStage) IsSet() bool

func (NullablePipelineStage) MarshalJSON 

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

func (*NullablePipelineStage) Set 

func (v *NullablePipelineStage) Set(val *PipelineStage)

func (*NullablePipelineStage) UnmarshalJSON 

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

func (*NullablePipelineStage) Unset 

func (v *NullablePipelineStage) Unset()

type NullablePipelineStageInput 

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

func NewNullablePipelineStageInput 

func NewNullablePipelineStageInput(val *PipelineStageInput) *NullablePipelineStageInput

func (NullablePipelineStageInput) Get 

func (v NullablePipelineStageInput) Get() *PipelineStageInput

func (NullablePipelineStageInput) IsSet 

func (v NullablePipelineStageInput) IsSet() bool

func (NullablePipelineStageInput) MarshalJSON 

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

func (*NullablePipelineStageInput) Set 

func (v *NullablePipelineStageInput) Set(val *PipelineStageInput)

func (*NullablePipelineStageInput) UnmarshalJSON 

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

func (*NullablePipelineStageInput) Unset 

func (v *NullablePipelineStageInput) Unset()

type NullablePipelineStagePatchInput 

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

func NewNullablePipelineStagePatchInput 

func NewNullablePipelineStagePatchInput(val *PipelineStagePatchInput) *NullablePipelineStagePatchInput

func (NullablePipelineStagePatchInput) Get 

func (v NullablePipelineStagePatchInput) Get() *PipelineStagePatchInput

func (NullablePipelineStagePatchInput) IsSet 

func (v NullablePipelineStagePatchInput) IsSet() bool

func (NullablePipelineStagePatchInput) MarshalJSON 

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

func (*NullablePipelineStagePatchInput) Set 

func (v *NullablePipelineStagePatchInput) Set(val *PipelineStagePatchInput)

func (*NullablePipelineStagePatchInput) UnmarshalJSON 

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

func (*NullablePipelineStagePatchInput) Unset 

func (v *NullablePipelineStagePatchInput) Unset()

type NullablePublicAuditInfo 

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

func NewNullablePublicAuditInfo 

func NewNullablePublicAuditInfo(val *PublicAuditInfo) *NullablePublicAuditInfo

func (NullablePublicAuditInfo) Get 

func (v NullablePublicAuditInfo) Get() *PublicAuditInfo

func (NullablePublicAuditInfo) IsSet 

func (v NullablePublicAuditInfo) IsSet() bool

func (NullablePublicAuditInfo) MarshalJSON 

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

func (*NullablePublicAuditInfo) Set 

func (v *NullablePublicAuditInfo) Set(val *PublicAuditInfo)

func (*NullablePublicAuditInfo) UnmarshalJSON 

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

func (*NullablePublicAuditInfo) Unset 

func (v *NullablePublicAuditInfo) 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 Pipeline 

type Pipeline struct {
	// A unique label used to organize pipelines in HubSpot's UI
	Label string `json:"label"`
	// The order for displaying this pipeline. If two pipelines have a matching `displayOrder`, they will be sorted alphabetically by label.
	DisplayOrder int32 `json:"displayOrder"`
	// A unique identifier generated by HubSpot that can be used to retrieve and update the pipeline.
	Id string `json:"id"`
	// The stages associated with the pipeline. They can be retrieved and updated via the pipeline stages endpoints.
	Stages []PipelineStage `json:"stages"`
	// The date the pipeline was created. The default pipelines will have createdAt = 0.
	CreatedAt time.Time `json:"createdAt"`
	// The date the pipeline was archived. `archivedAt` will only be present if the pipeline is archived.
	ArchivedAt *time.Time `json:"archivedAt,omitempty"`
	// The date the pipeline was last updated.
	UpdatedAt time.Time `json:"updatedAt"`
	// Whether the pipeline is archived.
	Archived bool `json:"archived"`
}

Pipeline A pipeline definition.

func NewPipeline 

func NewPipeline(label string, displayOrder int32, id string, stages []PipelineStage, createdAt time.Time, updatedAt time.Time, archived bool) *Pipeline

NewPipeline instantiates a new Pipeline 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 NewPipelineWithDefaults 

func NewPipelineWithDefaults() *Pipeline

NewPipelineWithDefaults instantiates a new Pipeline 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 (*Pipeline) GetArchived 

func (o *Pipeline) GetArchived() bool

GetArchived returns the Archived field value

func (*Pipeline) GetArchivedAt 

func (o *Pipeline) GetArchivedAt() time.Time

GetArchivedAt returns the ArchivedAt field value if set, zero value otherwise.

func (*Pipeline) GetArchivedAtOk 

func (o *Pipeline) GetArchivedAtOk() (*time.Time, bool)

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

func (*Pipeline) GetArchivedOk 

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

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

func (*Pipeline) GetCreatedAt 

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

GetCreatedAt returns the CreatedAt field value

func (*Pipeline) GetCreatedAtOk 

func (o *Pipeline) 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 (*Pipeline) GetDisplayOrder 

func (o *Pipeline) GetDisplayOrder() int32

GetDisplayOrder returns the DisplayOrder field value

func (*Pipeline) GetDisplayOrderOk 

func (o *Pipeline) GetDisplayOrderOk() (*int32, bool)

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

func (*Pipeline) GetId 

func (o *Pipeline) GetId() string

GetId returns the Id field value

func (*Pipeline) GetIdOk 

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

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

func (*Pipeline) GetLabel 

func (o *Pipeline) GetLabel() string

GetLabel returns the Label field value

func (*Pipeline) GetLabelOk 

func (o *Pipeline) GetLabelOk() (*string, bool)

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

func (*Pipeline) GetStages 

func (o *Pipeline) GetStages() []PipelineStage

GetStages returns the Stages field value

func (*Pipeline) GetStagesOk 

func (o *Pipeline) GetStagesOk() ([]PipelineStage, bool)

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

func (*Pipeline) GetUpdatedAt 

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

GetUpdatedAt returns the UpdatedAt field value

func (*Pipeline) GetUpdatedAtOk 

func (o *Pipeline) 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 (*Pipeline) HasArchivedAt 

func (o *Pipeline) HasArchivedAt() bool

HasArchivedAt returns a boolean if a field has been set.

func (Pipeline) MarshalJSON 

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

func (*Pipeline) SetArchived 

func (o *Pipeline) SetArchived(v bool)

SetArchived sets field value

func (*Pipeline) SetArchivedAt 

func (o *Pipeline) SetArchivedAt(v time.Time)

SetArchivedAt gets a reference to the given time.Time and assigns it to the ArchivedAt field.

func (*Pipeline) SetCreatedAt 

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

SetCreatedAt sets field value

func (*Pipeline) SetDisplayOrder 

func (o *Pipeline) SetDisplayOrder(v int32)

SetDisplayOrder sets field value

func (*Pipeline) SetId 

func (o *Pipeline) SetId(v string)

SetId sets field value

func (*Pipeline) SetLabel 

func (o *Pipeline) SetLabel(v string)

SetLabel sets field value

func (*Pipeline) SetStages 

func (o *Pipeline) SetStages(v []PipelineStage)

SetStages sets field value

func (*Pipeline) SetUpdatedAt 

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

SetUpdatedAt sets field value

type PipelineAuditsApiService 

type PipelineAuditsApiService service

PipelineAuditsApiService PipelineAuditsApi service

func (*PipelineAuditsApiService) GetAudit 

func (a *PipelineAuditsApiService) GetAudit(ctx context.Context, objectType string, pipelineId string) ApiGetAuditRequest

GetAudit Return an audit of all changes to the pipeline

Return a reverse chronological list of all mutations that have occurred on the pipeline identified by `{pipelineId}`. 

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

func (*PipelineAuditsApiService) GetAuditExecute 

func (a *PipelineAuditsApiService) GetAuditExecute(r ApiGetAuditRequest) (*CollectionResponsePublicAuditInfoNoPaging, *http.Response, error)

Execute executes the request 

@return CollectionResponsePublicAuditInfoNoPaging

type PipelineInput 

type PipelineInput struct {
	// A unique label used to organize pipelines in HubSpot's UI
	Label string `json:"label"`
	// The order for displaying this pipeline. If two pipelines have a matching `displayOrder`, they will be sorted alphabetically by label.
	DisplayOrder int32 `json:"displayOrder"`
	// Pipeline stage inputs used to create the new or replacement pipeline.
	Stages []PipelineStageInput `json:"stages"`
}

PipelineInput An input used to create or replace a pipeline's definition.

func NewPipelineInput 

func NewPipelineInput(label string, displayOrder int32, stages []PipelineStageInput) *PipelineInput

NewPipelineInput instantiates a new PipelineInput 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 NewPipelineInputWithDefaults 

func NewPipelineInputWithDefaults() *PipelineInput

NewPipelineInputWithDefaults instantiates a new PipelineInput 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 (*PipelineInput) GetDisplayOrder 

func (o *PipelineInput) GetDisplayOrder() int32

GetDisplayOrder returns the DisplayOrder field value

func (*PipelineInput) GetDisplayOrderOk 

func (o *PipelineInput) GetDisplayOrderOk() (*int32, bool)

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

func (*PipelineInput) GetLabel 

func (o *PipelineInput) GetLabel() string

GetLabel returns the Label field value

func (*PipelineInput) GetLabelOk 

func (o *PipelineInput) GetLabelOk() (*string, bool)

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

func (*PipelineInput) GetStages 

func (o *PipelineInput) GetStages() []PipelineStageInput

GetStages returns the Stages field value

func (*PipelineInput) GetStagesOk 

func (o *PipelineInput) GetStagesOk() ([]PipelineStageInput, bool)

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

func (PipelineInput) MarshalJSON 

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

func (*PipelineInput) SetDisplayOrder 

func (o *PipelineInput) SetDisplayOrder(v int32)

SetDisplayOrder sets field value

func (*PipelineInput) SetLabel 

func (o *PipelineInput) SetLabel(v string)

SetLabel sets field value

func (*PipelineInput) SetStages 

func (o *PipelineInput) SetStages(v []PipelineStageInput)

SetStages sets field value

type PipelinePatchInput 

type PipelinePatchInput struct {
	// A unique label used to organize pipelines in HubSpot's UI
	Label *string `json:"label,omitempty"`
	// The order for displaying this pipeline. If two pipelines have a matching `displayOrder`, they will be sorted alphabetically by label.
	DisplayOrder *int32 `json:"displayOrder,omitempty"`
	// Whether the pipeline is archived. This property should only be provided when restoring an archived pipeline. If it's provided in any other call, the request will fail and a `400 Bad Request` will be returned.
	Archived *bool `json:"archived,omitempty"`
}

PipelinePatchInput An input used to update some properties on a pipeline definition.

func NewPipelinePatchInput 

func NewPipelinePatchInput() *PipelinePatchInput

NewPipelinePatchInput instantiates a new PipelinePatchInput 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 NewPipelinePatchInputWithDefaults 

func NewPipelinePatchInputWithDefaults() *PipelinePatchInput

NewPipelinePatchInputWithDefaults instantiates a new PipelinePatchInput 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 (*PipelinePatchInput) GetArchived 

func (o *PipelinePatchInput) GetArchived() bool

GetArchived returns the Archived field value if set, zero value otherwise.

func (*PipelinePatchInput) GetArchivedOk 

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

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

func (*PipelinePatchInput) GetDisplayOrder 

func (o *PipelinePatchInput) GetDisplayOrder() int32

GetDisplayOrder returns the DisplayOrder field value if set, zero value otherwise.

func (*PipelinePatchInput) GetDisplayOrderOk 

func (o *PipelinePatchInput) GetDisplayOrderOk() (*int32, bool)

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

func (*PipelinePatchInput) GetLabel 

func (o *PipelinePatchInput) GetLabel() string

GetLabel returns the Label field value if set, zero value otherwise.

func (*PipelinePatchInput) GetLabelOk 

func (o *PipelinePatchInput) GetLabelOk() (*string, bool)

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

func (*PipelinePatchInput) HasArchived 

func (o *PipelinePatchInput) HasArchived() bool

HasArchived returns a boolean if a field has been set.

func (*PipelinePatchInput) HasDisplayOrder 

func (o *PipelinePatchInput) HasDisplayOrder() bool

HasDisplayOrder returns a boolean if a field has been set.

func (*PipelinePatchInput) HasLabel 

func (o *PipelinePatchInput) HasLabel() bool

HasLabel returns a boolean if a field has been set.

func (PipelinePatchInput) MarshalJSON 

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

func (*PipelinePatchInput) SetArchived 

func (o *PipelinePatchInput) SetArchived(v bool)

SetArchived gets a reference to the given bool and assigns it to the Archived field.

func (*PipelinePatchInput) SetDisplayOrder 

func (o *PipelinePatchInput) SetDisplayOrder(v int32)

SetDisplayOrder gets a reference to the given int32 and assigns it to the DisplayOrder field.

func (*PipelinePatchInput) SetLabel 

func (o *PipelinePatchInput) SetLabel(v string)

SetLabel gets a reference to the given string and assigns it to the Label field.

type PipelineStage 

type PipelineStage struct {
	// A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline.
	Label string `json:"label"`
	// The order for displaying this pipeline stage. If two pipeline stages have a matching `displayOrder`, they will be sorted alphabetically by label.
	DisplayOrder int32 `json:"displayOrder"`
	// A JSON object containing properties that are not present on all object pipelines.  For `deals` pipelines, the `probability` field is required (`{ \"probability\": 0.5 }`), and represents the likelihood a deal will close. Possible values are between 0.0 and 1.0 in increments of 0.1.  For `tickets` pipelines, the `ticketState` field is optional (`{ \"ticketState\": \"OPEN\" }`), and represents whether the ticket remains open or has been closed by a member of your Support team. Possible values are `OPEN` or `CLOSED`.
	Metadata map[string]string `json:"metadata"`
	// A unique identifier generated by HubSpot that can be used to retrieve and update the pipeline stage.
	Id string `json:"id"`
	// The date the pipeline stage was created. The stages on default pipelines will have createdAt = 0.
	CreatedAt time.Time `json:"createdAt"`
	// The date the pipeline was archived. `archivedAt` will only be present if the pipeline is archived.
	ArchivedAt *time.Time `json:"archivedAt,omitempty"`
	// The date the pipeline stage was last updated.
	UpdatedAt time.Time `json:"updatedAt"`
	// Whether the pipeline is archived.
	Archived bool `json:"archived"`
}

PipelineStage A pipeline stage definition.

func NewPipelineStage 

func NewPipelineStage(label string, displayOrder int32, metadata map[string]string, id string, createdAt time.Time, updatedAt time.Time, archived bool) *PipelineStage

NewPipelineStage instantiates a new PipelineStage 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 NewPipelineStageWithDefaults 

func NewPipelineStageWithDefaults() *PipelineStage

NewPipelineStageWithDefaults instantiates a new PipelineStage 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 (*PipelineStage) GetArchived 

func (o *PipelineStage) GetArchived() bool

GetArchived returns the Archived field value

func (*PipelineStage) GetArchivedAt 

func (o *PipelineStage) GetArchivedAt() time.Time

GetArchivedAt returns the ArchivedAt field value if set, zero value otherwise.

func (*PipelineStage) GetArchivedAtOk 

func (o *PipelineStage) GetArchivedAtOk() (*time.Time, bool)

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

func (*PipelineStage) GetArchivedOk 

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

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

func (*PipelineStage) GetCreatedAt 

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

GetCreatedAt returns the CreatedAt field value

func (*PipelineStage) GetCreatedAtOk 

func (o *PipelineStage) 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 (*PipelineStage) GetDisplayOrder 

func (o *PipelineStage) GetDisplayOrder() int32

GetDisplayOrder returns the DisplayOrder field value

func (*PipelineStage) GetDisplayOrderOk 

func (o *PipelineStage) GetDisplayOrderOk() (*int32, bool)

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

func (*PipelineStage) GetId 

func (o *PipelineStage) GetId() string

GetId returns the Id field value

func (*PipelineStage) GetIdOk 

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

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

func (*PipelineStage) GetLabel 

func (o *PipelineStage) GetLabel() string

GetLabel returns the Label field value

func (*PipelineStage) GetLabelOk 

func (o *PipelineStage) GetLabelOk() (*string, bool)

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

func (*PipelineStage) GetMetadata 

func (o *PipelineStage) GetMetadata() map[string]string

GetMetadata returns the Metadata field value

func (*PipelineStage) GetMetadataOk 

func (o *PipelineStage) GetMetadataOk() (*map[string]string, bool)

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

func (*PipelineStage) GetUpdatedAt 

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

GetUpdatedAt returns the UpdatedAt field value

func (*PipelineStage) GetUpdatedAtOk 

func (o *PipelineStage) 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 (*PipelineStage) HasArchivedAt 

func (o *PipelineStage) HasArchivedAt() bool

HasArchivedAt returns a boolean if a field has been set.

func (PipelineStage) MarshalJSON 

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

func (*PipelineStage) SetArchived 

func (o *PipelineStage) SetArchived(v bool)

SetArchived sets field value

func (*PipelineStage) SetArchivedAt 

func (o *PipelineStage) SetArchivedAt(v time.Time)

SetArchivedAt gets a reference to the given time.Time and assigns it to the ArchivedAt field.

func (*PipelineStage) SetCreatedAt 

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

SetCreatedAt sets field value

func (*PipelineStage) SetDisplayOrder 

func (o *PipelineStage) SetDisplayOrder(v int32)

SetDisplayOrder sets field value

func (*PipelineStage) SetId 

func (o *PipelineStage) SetId(v string)

SetId sets field value

func (*PipelineStage) SetLabel 

func (o *PipelineStage) SetLabel(v string)

SetLabel sets field value

func (*PipelineStage) SetMetadata 

func (o *PipelineStage) SetMetadata(v map[string]string)

SetMetadata sets field value

func (*PipelineStage) SetUpdatedAt 

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

SetUpdatedAt sets field value

type PipelineStageAuditsApiService 

type PipelineStageAuditsApiService service

PipelineStageAuditsApiService PipelineStageAuditsApi service

func (*PipelineStageAuditsApiService) StagesGetAudit 

func (a *PipelineStageAuditsApiService) StagesGetAudit(ctx context.Context, objectType string, stageId string) ApiStagesGetAuditRequest

StagesGetAudit Return an audit of all changes to the pipeline stage

Return a reverse chronological list of all mutations that have occurred on the pipeline stage identified by `{stageId}`. 

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

func (*PipelineStageAuditsApiService) StagesGetAuditExecute 

func (a *PipelineStageAuditsApiService) StagesGetAuditExecute(r ApiStagesGetAuditRequest) (*CollectionResponsePublicAuditInfoNoPaging, *http.Response, error)

Execute executes the request 

@return CollectionResponsePublicAuditInfoNoPaging

type PipelineStageInput 

type PipelineStageInput struct {
	// A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline.
	Label string `json:"label"`
	// The order for displaying this pipeline stage. If two pipeline stages have a matching `displayOrder`, they will be sorted alphabetically by label.
	DisplayOrder int32 `json:"displayOrder"`
	// A JSON object containing properties that are not present on all object pipelines.  For `deals` pipelines, the `probability` field is required (`{ \"probability\": 0.5 }`), and represents the likelihood a deal will close. Possible values are between 0.0 and 1.0 in increments of 0.1.  For `tickets` pipelines, the `ticketState` field is optional (`{ \"ticketState\": \"OPEN\" }`), and represents whether the ticket remains open or has been closed by a member of your Support team. Possible values are `OPEN` or `CLOSED`.
	Metadata map[string]string `json:"metadata"`
}

PipelineStageInput An input used to create or replace a pipeline stage's definition.

func NewPipelineStageInput 

func NewPipelineStageInput(label string, displayOrder int32, metadata map[string]string) *PipelineStageInput

NewPipelineStageInput instantiates a new PipelineStageInput 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 NewPipelineStageInputWithDefaults 

func NewPipelineStageInputWithDefaults() *PipelineStageInput

NewPipelineStageInputWithDefaults instantiates a new PipelineStageInput 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 (*PipelineStageInput) GetDisplayOrder 

func (o *PipelineStageInput) GetDisplayOrder() int32

GetDisplayOrder returns the DisplayOrder field value

func (*PipelineStageInput) GetDisplayOrderOk 

func (o *PipelineStageInput) GetDisplayOrderOk() (*int32, bool)

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

func (*PipelineStageInput) GetLabel 

func (o *PipelineStageInput) GetLabel() string

GetLabel returns the Label field value

func (*PipelineStageInput) GetLabelOk 

func (o *PipelineStageInput) GetLabelOk() (*string, bool)

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

func (*PipelineStageInput) GetMetadata 

func (o *PipelineStageInput) GetMetadata() map[string]string

GetMetadata returns the Metadata field value

func (*PipelineStageInput) GetMetadataOk 

func (o *PipelineStageInput) GetMetadataOk() (*map[string]string, bool)

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

func (PipelineStageInput) MarshalJSON 

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

func (*PipelineStageInput) SetDisplayOrder 

func (o *PipelineStageInput) SetDisplayOrder(v int32)

SetDisplayOrder sets field value

func (*PipelineStageInput) SetLabel 

func (o *PipelineStageInput) SetLabel(v string)

SetLabel sets field value

func (*PipelineStageInput) SetMetadata 

func (o *PipelineStageInput) SetMetadata(v map[string]string)

SetMetadata sets field value

type PipelineStagePatchInput 

type PipelineStagePatchInput struct {
	// A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline.
	Label *string `json:"label,omitempty"`
	// Whether the pipeline is archived.
	Archived *bool `json:"archived,omitempty"`
	// The order for displaying this pipeline stage. If two pipeline stages have a matching `displayOrder`, they will be sorted alphabetically by label.
	DisplayOrder *int32 `json:"displayOrder,omitempty"`
	// A JSON object containing properties that are not present on all object pipelines.  For `deals` pipelines, the `probability` field is required (`{ \"probability\": 0.5 }`), and represents the likelihood a deal will close. Possible values are between 0.0 and 1.0 in increments of 0.1.  For `tickets` pipelines, the `ticketState` field is optional (`{ \"ticketState\": \"OPEN\" }`), and represents whether the ticket remains open or has been closed by a member of your Support team. Possible values are `OPEN` or `CLOSED`.
	Metadata map[string]string `json:"metadata"`
}

PipelineStagePatchInput An input used to update some properties on a pipeline definition.

func NewPipelineStagePatchInput 

func NewPipelineStagePatchInput(metadata map[string]string) *PipelineStagePatchInput

NewPipelineStagePatchInput instantiates a new PipelineStagePatchInput 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 NewPipelineStagePatchInputWithDefaults 

func NewPipelineStagePatchInputWithDefaults() *PipelineStagePatchInput

NewPipelineStagePatchInputWithDefaults instantiates a new PipelineStagePatchInput 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 (*PipelineStagePatchInput) GetArchived 

func (o *PipelineStagePatchInput) GetArchived() bool

GetArchived returns the Archived field value if set, zero value otherwise.

func (*PipelineStagePatchInput) GetArchivedOk 

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

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

func (*PipelineStagePatchInput) GetDisplayOrder 

func (o *PipelineStagePatchInput) GetDisplayOrder() int32

GetDisplayOrder returns the DisplayOrder field value if set, zero value otherwise.

func (*PipelineStagePatchInput) GetDisplayOrderOk 

func (o *PipelineStagePatchInput) GetDisplayOrderOk() (*int32, bool)

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

func (*PipelineStagePatchInput) GetLabel 

func (o *PipelineStagePatchInput) GetLabel() string

GetLabel returns the Label field value if set, zero value otherwise.

func (*PipelineStagePatchInput) GetLabelOk 

func (o *PipelineStagePatchInput) GetLabelOk() (*string, bool)

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

func (*PipelineStagePatchInput) GetMetadata 

func (o *PipelineStagePatchInput) GetMetadata() map[string]string

GetMetadata returns the Metadata field value

func (*PipelineStagePatchInput) GetMetadataOk 

func (o *PipelineStagePatchInput) GetMetadataOk() (*map[string]string, bool)

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

func (*PipelineStagePatchInput) HasArchived 

func (o *PipelineStagePatchInput) HasArchived() bool

HasArchived returns a boolean if a field has been set.

func (*PipelineStagePatchInput) HasDisplayOrder 

func (o *PipelineStagePatchInput) HasDisplayOrder() bool

HasDisplayOrder returns a boolean if a field has been set.

func (*PipelineStagePatchInput) HasLabel 

func (o *PipelineStagePatchInput) HasLabel() bool

HasLabel returns a boolean if a field has been set.

func (PipelineStagePatchInput) MarshalJSON 

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

func (*PipelineStagePatchInput) SetArchived 

func (o *PipelineStagePatchInput) SetArchived(v bool)

SetArchived gets a reference to the given bool and assigns it to the Archived field.

func (*PipelineStagePatchInput) SetDisplayOrder 

func (o *PipelineStagePatchInput) SetDisplayOrder(v int32)

SetDisplayOrder gets a reference to the given int32 and assigns it to the DisplayOrder field.

func (*PipelineStagePatchInput) SetLabel 

func (o *PipelineStagePatchInput) SetLabel(v string)

SetLabel gets a reference to the given string and assigns it to the Label field.

func (*PipelineStagePatchInput) SetMetadata 

func (o *PipelineStagePatchInput) SetMetadata(v map[string]string)

SetMetadata sets field value

type PipelineStagesApiService 

type PipelineStagesApiService service

PipelineStagesApiService PipelineStagesApi service

func (*PipelineStagesApiService) StagesArchive 

func (a *PipelineStagesApiService) StagesArchive(ctx context.Context, objectType string, pipelineId string, stageId string) ApiStagesArchiveRequest

StagesArchive Delete a pipeline stage

Delete the pipeline stage identified by `{stageId}` associated with the pipeline identified by `{pipelineId}`. 

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

func (*PipelineStagesApiService) StagesArchiveExecute 

func (a *PipelineStagesApiService) StagesArchiveExecute(r ApiStagesArchiveRequest) (*http.Response, error)

Execute executes the request

func (*PipelineStagesApiService) StagesCreate 

func (a *PipelineStagesApiService) StagesCreate(ctx context.Context, objectType string, pipelineId string) ApiStagesCreateRequest

StagesCreate Create a pipeline stage

Create a new stage associated with the pipeline identified by `{pipelineId}`. The entire stage object, including its unique ID, will be returned in the response. 

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

func (*PipelineStagesApiService) StagesCreateExecute 

func (a *PipelineStagesApiService) StagesCreateExecute(r ApiStagesCreateRequest) (*PipelineStage, *http.Response, error)

Execute executes the request 

@return PipelineStage

func (*PipelineStagesApiService) StagesGetAll 

func (a *PipelineStagesApiService) StagesGetAll(ctx context.Context, objectType string, pipelineId string) ApiStagesGetAllRequest

StagesGetAll Return all stages of a pipeline

Return all the stages associated with the pipeline identified by `{pipelineId}`. 

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

func (*PipelineStagesApiService) StagesGetAllExecute 

func (a *PipelineStagesApiService) StagesGetAllExecute(r ApiStagesGetAllRequest) (*CollectionResponsePipelineStageNoPaging, *http.Response, error)

Execute executes the request 

@return CollectionResponsePipelineStageNoPaging

func (*PipelineStagesApiService) StagesGetByID 

func (a *PipelineStagesApiService) StagesGetByID(ctx context.Context, objectType string, pipelineId string, stageId string) ApiStagesGetByIDRequest

StagesGetByID Return a pipeline stage by ID

Return the stage identified by `{stageId}` associated with the pipeline identified by `{pipelineId}`. 

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

func (*PipelineStagesApiService) StagesGetByIDExecute 

func (a *PipelineStagesApiService) StagesGetByIDExecute(r ApiStagesGetByIDRequest) (*PipelineStage, *http.Response, error)

Execute executes the request 

@return PipelineStage

func (*PipelineStagesApiService) StagesReplace 

func (a *PipelineStagesApiService) StagesReplace(ctx context.Context, objectType string, pipelineId string, stageId string) ApiStagesReplaceRequest

StagesReplace Replace a pipeline stage

Replace all the properties of an existing pipeline stage with the values provided. The updated stage will be returned in the response. 

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

func (*PipelineStagesApiService) StagesReplaceExecute 

func (a *PipelineStagesApiService) StagesReplaceExecute(r ApiStagesReplaceRequest) (*PipelineStage, *http.Response, error)

Execute executes the request 

@return PipelineStage

func (*PipelineStagesApiService) StagesUpdate 

func (a *PipelineStagesApiService) StagesUpdate(ctx context.Context, objectType string, pipelineId string, stageId string) ApiStagesUpdateRequest

StagesUpdate Update a pipeline stage

Perform a partial update of the pipeline stage identified by `{stageId}` associated with the pipeline identified by `{pipelineId}`. Any properties not included in this update will keep their existing values. The updated stage will be returned in the response. 

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

func (*PipelineStagesApiService) StagesUpdateExecute 

func (a *PipelineStagesApiService) StagesUpdateExecute(r ApiStagesUpdateRequest) (*PipelineStage, *http.Response, error)

Execute executes the request 

@return PipelineStage

type PipelinesApiService 

type PipelinesApiService service

PipelinesApiService PipelinesApi service

func (*PipelinesApiService) Archive 

func (a *PipelinesApiService) Archive(ctx context.Context, objectType string, pipelineId string) ApiArchiveRequest

Archive Delete a pipeline

Delete the pipeline identified by `{pipelineId}`. 

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

func (*PipelinesApiService) ArchiveExecute 

func (a *PipelinesApiService) ArchiveExecute(r ApiArchiveRequest) (*http.Response, error)

Execute executes the request

func (*PipelinesApiService) Create 

func (a *PipelinesApiService) Create(ctx context.Context, objectType string) ApiCreateRequest

Create Create a pipeline

Create a new pipeline with the provided property values. The entire pipeline object, including its unique ID, will be returned in the response. 

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

func (*PipelinesApiService) CreateExecute 

func (a *PipelinesApiService) CreateExecute(r ApiCreateRequest) (*Pipeline, *http.Response, error)

Execute executes the request 

@return Pipeline

func (*PipelinesApiService) GetAll 

func (a *PipelinesApiService) GetAll(ctx context.Context, objectType string) ApiGetAllRequest

GetAll Retrieve all pipelines

Return all pipelines for the object type specified by `{objectType}`. 

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

func (*PipelinesApiService) GetAllExecute 

func (a *PipelinesApiService) GetAllExecute(r ApiGetAllRequest) (*CollectionResponsePipelineNoPaging, *http.Response, error)

Execute executes the request 

@return CollectionResponsePipelineNoPaging

func (*PipelinesApiService) GetByID 

func (a *PipelinesApiService) GetByID(ctx context.Context, objectType string, pipelineId string) ApiGetByIDRequest

GetByID Return a pipeline by ID

Return a single pipeline object identified by its unique `{pipelineId}`. 

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

func (*PipelinesApiService) GetByIDExecute 

func (a *PipelinesApiService) GetByIDExecute(r ApiGetByIDRequest) (*Pipeline, *http.Response, error)

Execute executes the request 

@return Pipeline

func (*PipelinesApiService) Replace 

func (a *PipelinesApiService) Replace(ctx context.Context, objectType string, pipelineId string) ApiReplaceRequest

Replace Replace a pipeline

Replace all the properties of an existing pipeline with the values provided. This will overwrite any existing pipeline stages. The updated pipeline will be returned in the response. 

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

func (*PipelinesApiService) ReplaceExecute 

func (a *PipelinesApiService) ReplaceExecute(r ApiReplaceRequest) (*Pipeline, *http.Response, error)

Execute executes the request 

@return Pipeline

func (*PipelinesApiService) Update 

func (a *PipelinesApiService) Update(ctx context.Context, objectType string, pipelineId string) ApiUpdateRequest

Update Update a pipeline

Perform a partial update of the pipeline identified by `{pipelineId}`. The updated pipeline will be returned in the response. 

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

func (*PipelinesApiService) UpdateExecute 

func (a *PipelinesApiService) UpdateExecute(r ApiUpdateRequest) (*Pipeline, *http.Response, error)

Execute executes the request 

@return Pipeline

type PublicAuditInfo 

type PublicAuditInfo struct {
	PortalId   int32                  `json:"portalId"`
	Identifier string                 `json:"identifier"`
	Action     string                 `json:"action"`
	Timestamp  *time.Time             `json:"timestamp,omitempty"`
	Message    *string                `json:"message,omitempty"`
	RawObject  map[string]interface{} `json:"rawObject,omitempty"`
	FromUserId *int32                 `json:"fromUserId,omitempty"`
}

PublicAuditInfo struct for PublicAuditInfo

func NewPublicAuditInfo 

func NewPublicAuditInfo(portalId int32, identifier string, action string) *PublicAuditInfo

NewPublicAuditInfo instantiates a new PublicAuditInfo 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 NewPublicAuditInfoWithDefaults 

func NewPublicAuditInfoWithDefaults() *PublicAuditInfo

NewPublicAuditInfoWithDefaults instantiates a new PublicAuditInfo 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 (*PublicAuditInfo) GetAction 

func (o *PublicAuditInfo) GetAction() string

GetAction returns the Action field value

func (*PublicAuditInfo) GetActionOk 

func (o *PublicAuditInfo) GetActionOk() (*string, bool)

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

func (*PublicAuditInfo) GetFromUserId 

func (o *PublicAuditInfo) GetFromUserId() int32

GetFromUserId returns the FromUserId field value if set, zero value otherwise.

func (*PublicAuditInfo) GetFromUserIdOk 

func (o *PublicAuditInfo) GetFromUserIdOk() (*int32, bool)

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

func (*PublicAuditInfo) GetIdentifier 

func (o *PublicAuditInfo) GetIdentifier() string

GetIdentifier returns the Identifier field value

func (*PublicAuditInfo) GetIdentifierOk 

func (o *PublicAuditInfo) GetIdentifierOk() (*string, bool)

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

func (*PublicAuditInfo) GetMessage 

func (o *PublicAuditInfo) GetMessage() string

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

func (*PublicAuditInfo) GetMessageOk 

func (o *PublicAuditInfo) 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 (*PublicAuditInfo) GetPortalId 

func (o *PublicAuditInfo) GetPortalId() int32

GetPortalId returns the PortalId field value

func (*PublicAuditInfo) GetPortalIdOk 

func (o *PublicAuditInfo) GetPortalIdOk() (*int32, bool)

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

func (*PublicAuditInfo) GetRawObject 

func (o *PublicAuditInfo) GetRawObject() map[string]interface{}

GetRawObject returns the RawObject field value if set, zero value otherwise.

func (*PublicAuditInfo) GetRawObjectOk 

func (o *PublicAuditInfo) GetRawObjectOk() (map[string]interface{}, bool)

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

func (*PublicAuditInfo) GetTimestamp 

func (o *PublicAuditInfo) GetTimestamp() time.Time

GetTimestamp returns the Timestamp field value if set, zero value otherwise.

func (*PublicAuditInfo) GetTimestampOk 

func (o *PublicAuditInfo) GetTimestampOk() (*time.Time, bool)

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

func (*PublicAuditInfo) HasFromUserId 

func (o *PublicAuditInfo) HasFromUserId() bool

HasFromUserId returns a boolean if a field has been set.

func (*PublicAuditInfo) HasMessage 

func (o *PublicAuditInfo) HasMessage() bool

HasMessage returns a boolean if a field has been set.

func (*PublicAuditInfo) HasRawObject 

func (o *PublicAuditInfo) HasRawObject() bool

HasRawObject returns a boolean if a field has been set.

func (*PublicAuditInfo) HasTimestamp 

func (o *PublicAuditInfo) HasTimestamp() bool

HasTimestamp returns a boolean if a field has been set.

func (PublicAuditInfo) MarshalJSON 

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

func (*PublicAuditInfo) SetAction 

func (o *PublicAuditInfo) SetAction(v string)

SetAction sets field value

func (*PublicAuditInfo) SetFromUserId 

func (o *PublicAuditInfo) SetFromUserId(v int32)

SetFromUserId gets a reference to the given int32 and assigns it to the FromUserId field.

func (*PublicAuditInfo) SetIdentifier 

func (o *PublicAuditInfo) SetIdentifier(v string)

SetIdentifier sets field value

func (*PublicAuditInfo) SetMessage 

func (o *PublicAuditInfo) SetMessage(v string)

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

func (*PublicAuditInfo) SetPortalId 

func (o *PublicAuditInfo) SetPortalId(v int32)

SetPortalId sets field value

func (*PublicAuditInfo) SetRawObject 

func (o *PublicAuditInfo) SetRawObject(v map[string]interface{})

SetRawObject gets a reference to the given map[string]interface{} and assigns it to the RawObject field.

func (*PublicAuditInfo) SetTimestamp 

func (o *PublicAuditInfo) SetTimestamp(v time.Time)

SetTimestamp gets a reference to the given time.Time and assigns it to the Timestamp field.

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.