pipelines

package
v0.0.0-...-2284865 Latest Latest
Warning

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

 Go to latest Published: Oct 26, 2022 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package pipelines provides primitives to interact with the openapi HTTP API.

Code generated by github.com/faetools/devtool version (devel) DO NOT EDIT.

Package pipelines provides primitives to interact with the openapi HTTP API.

Code generated by github.com/faetools/devtool version (devel) DO NOT EDIT.

Index

Constants

View Source 
const (
	HapikeyScopes       = "hapikey.Scopes"
	Oauth2_legacyScopes = "oauth2_legacy.Scopes"
)
View Source 
const DefaultServer = "https://api.hubapi.com/"

DefaultServer is the default server to be used.

Variables

This section is empty.

Functions

This section is empty.

Types

type ArchivePipelineResponse 

type ArchivePipelineResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func (ArchivePipelineResponse) Status 

func (r ArchivePipelineResponse) Status() string

Status returns HTTPResponse.Status

func (ArchivePipelineResponse) StatusCode 

func (r ArchivePipelineResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ArchiveStageResponse 

type ArchiveStageResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func (ArchiveStageResponse) Status 

func (r ArchiveStageResponse) Status() string

Status returns HTTPResponse.Status

func (ArchiveStageResponse) StatusCode 

func (r ArchiveStageResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Client 

type Client client.Client

Client conforms to the OpenAPI3 specification for this service.

func NewClient 

func NewClient(opts ...client.Option) (*Client, error)

NewClient creates a new Client with reasonable defaults.

func (*Client) ArchivePipeline 

func (c *Client) ArchivePipeline(ctx context.Context, objectType string, pipelineId string, reqEditors ...client.RequestEditorFn) (*ArchivePipelineResponse, error)

ArchivePipeline request returning *ArchivePipelineResponse

func (*Client) ArchiveStage 

func (c *Client) ArchiveStage(ctx context.Context, objectType string, pipelineId string, stageId string, reqEditors ...client.RequestEditorFn) (*ArchiveStageResponse, error)

ArchiveStage request returning *ArchiveStageResponse

func (*Client) CreateObjectType 

func (c *Client) CreateObjectType(ctx context.Context, objectType string, body CreateObjectTypeJSONRequestBody, reqEditors ...client.RequestEditorFn) (*CreateObjectTypeResponse, error)

func (*Client) CreateObjectTypeWithBody 

func (c *Client) CreateObjectTypeWithBody(ctx context.Context, objectType string, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*CreateObjectTypeResponse, error)

CreateObjectTypeWithBody request with arbitrary body returning *CreateObjectTypeResponse

func (*Client) CreateStages 

func (c *Client) CreateStages(ctx context.Context, objectType string, pipelineId string, body CreateStagesJSONRequestBody, reqEditors ...client.RequestEditorFn) (*CreateStagesResponse, error)

func (*Client) CreateStagesWithBody 

func (c *Client) CreateStagesWithBody(ctx context.Context, objectType string, pipelineId string, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*CreateStagesResponse, error)

CreateStagesWithBody request with arbitrary body returning *CreateStagesResponse

func (*Client) GetAllObjectType 

func (c *Client) GetAllObjectType(ctx context.Context, objectType string, params *GetAllObjectTypeParams, reqEditors ...client.RequestEditorFn) (*GetAllObjectTypeResponse, error)

GetAllObjectType request returning *GetAllObjectTypeResponse

func (*Client) GetAllStages 

func (c *Client) GetAllStages(ctx context.Context, objectType string, pipelineId string, params *GetAllStagesParams, reqEditors ...client.RequestEditorFn) (*GetAllStagesResponse, error)

GetAllStages request returning *GetAllStagesResponse

func (*Client) GetPipeline 

func (c *Client) GetPipeline(ctx context.Context, objectType string, pipelineId string, params *GetPipelineParams, reqEditors ...client.RequestEditorFn) (*GetPipelineResponse, error)

GetPipeline request returning *GetPipelineResponse

func (*Client) GetStage 

func (c *Client) GetStage(ctx context.Context, objectType string, pipelineId string, stageId string, params *GetStageParams, reqEditors ...client.RequestEditorFn) (*GetStageResponse, error)

GetStage request returning *GetStageResponse

func (*Client) ReplacePipeline 

func (c *Client) ReplacePipeline(ctx context.Context, objectType string, pipelineId string, body ReplacePipelineJSONRequestBody, reqEditors ...client.RequestEditorFn) (*ReplacePipelineResponse, error)

func (*Client) ReplacePipelineWithBody 

func (c *Client) ReplacePipelineWithBody(ctx context.Context, objectType string, pipelineId string, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*ReplacePipelineResponse, error)

ReplacePipelineWithBody request with arbitrary body returning *ReplacePipelineResponse

func (*Client) ReplaceStage 

func (c *Client) ReplaceStage(ctx context.Context, objectType string, pipelineId string, stageId string, body ReplaceStageJSONRequestBody, reqEditors ...client.RequestEditorFn) (*ReplaceStageResponse, error)

func (*Client) ReplaceStageWithBody 

func (c *Client) ReplaceStageWithBody(ctx context.Context, objectType string, pipelineId string, stageId string, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*ReplaceStageResponse, error)

ReplaceStageWithBody request with arbitrary body returning *ReplaceStageResponse

func (*Client) UpdatePipeline 

func (c *Client) UpdatePipeline(ctx context.Context, objectType string, pipelineId string, params *UpdatePipelineParams, body UpdatePipelineJSONRequestBody, reqEditors ...client.RequestEditorFn) (*UpdatePipelineResponse, error)

func (*Client) UpdatePipelineWithBody 

func (c *Client) UpdatePipelineWithBody(ctx context.Context, objectType string, pipelineId string, params *UpdatePipelineParams, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*UpdatePipelineResponse, error)

UpdatePipelineWithBody request with arbitrary body returning *UpdatePipelineResponse

func (*Client) UpdateStage 

func (c *Client) UpdateStage(ctx context.Context, objectType string, pipelineId string, stageId string, params *UpdateStageParams, body UpdateStageJSONRequestBody, reqEditors ...client.RequestEditorFn) (*UpdateStageResponse, error)

func (*Client) UpdateStageWithBody 

func (c *Client) UpdateStageWithBody(ctx context.Context, objectType string, pipelineId string, stageId string, params *UpdateStageParams, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*UpdateStageResponse, error)

UpdateStageWithBody request with arbitrary body returning *UpdateStageResponse

type ClientInterface 

type ClientInterface interface {
	// GetAllObjectType request
	GetAllObjectType(ctx context.Context, objectType string, params *GetAllObjectTypeParams, reqEditors ...client.RequestEditorFn) (*GetAllObjectTypeResponse, error)

	// CreateObjectType request with any body
	CreateObjectTypeWithBody(ctx context.Context, objectType string, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*CreateObjectTypeResponse, error)
	CreateObjectType(ctx context.Context, objectType string, body CreateObjectTypeJSONRequestBody, reqEditors ...client.RequestEditorFn) (*CreateObjectTypeResponse, error)

	// ArchivePipeline request
	ArchivePipeline(ctx context.Context, objectType string, pipelineId string, reqEditors ...client.RequestEditorFn) (*ArchivePipelineResponse, error)

	// GetPipeline request
	GetPipeline(ctx context.Context, objectType string, pipelineId string, params *GetPipelineParams, reqEditors ...client.RequestEditorFn) (*GetPipelineResponse, error)

	// UpdatePipeline request with any body
	UpdatePipelineWithBody(ctx context.Context, objectType string, pipelineId string, params *UpdatePipelineParams, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*UpdatePipelineResponse, error)
	UpdatePipeline(ctx context.Context, objectType string, pipelineId string, params *UpdatePipelineParams, body UpdatePipelineJSONRequestBody, reqEditors ...client.RequestEditorFn) (*UpdatePipelineResponse, error)

	// ReplacePipeline request with any body
	ReplacePipelineWithBody(ctx context.Context, objectType string, pipelineId string, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*ReplacePipelineResponse, error)
	ReplacePipeline(ctx context.Context, objectType string, pipelineId string, body ReplacePipelineJSONRequestBody, reqEditors ...client.RequestEditorFn) (*ReplacePipelineResponse, error)

	// GetAllStages request
	GetAllStages(ctx context.Context, objectType string, pipelineId string, params *GetAllStagesParams, reqEditors ...client.RequestEditorFn) (*GetAllStagesResponse, error)

	// CreateStages request with any body
	CreateStagesWithBody(ctx context.Context, objectType string, pipelineId string, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*CreateStagesResponse, error)
	CreateStages(ctx context.Context, objectType string, pipelineId string, body CreateStagesJSONRequestBody, reqEditors ...client.RequestEditorFn) (*CreateStagesResponse, error)

	// ArchiveStage request
	ArchiveStage(ctx context.Context, objectType string, pipelineId string, stageId string, reqEditors ...client.RequestEditorFn) (*ArchiveStageResponse, error)

	// GetStage request
	GetStage(ctx context.Context, objectType string, pipelineId string, stageId string, params *GetStageParams, reqEditors ...client.RequestEditorFn) (*GetStageResponse, error)

	// UpdateStage request with any body
	UpdateStageWithBody(ctx context.Context, objectType string, pipelineId string, stageId string, params *UpdateStageParams, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*UpdateStageResponse, error)
	UpdateStage(ctx context.Context, objectType string, pipelineId string, stageId string, params *UpdateStageParams, body UpdateStageJSONRequestBody, reqEditors ...client.RequestEditorFn) (*UpdateStageResponse, error)

	// ReplaceStage request with any body
	ReplaceStageWithBody(ctx context.Context, objectType string, pipelineId string, stageId string, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*ReplaceStageResponse, error)
	ReplaceStage(ctx context.Context, objectType string, pipelineId string, stageId string, body ReplaceStageJSONRequestBody, reqEditors ...client.RequestEditorFn) (*ReplaceStageResponse, error)
}

ClientInterface interface specification for the client.

type CollectionResponsePipeline 

type CollectionResponsePipeline struct {
	Paging  *Paging    `json:"paging,omitempty"`
	Results []Pipeline `json:"results"`
}

CollectionResponsePipeline defines model for CollectionResponsePipeline.

type CollectionResponsePipelineStage 

type CollectionResponsePipelineStage struct {
	Paging  *Paging         `json:"paging,omitempty"`
	Results []PipelineStage `json:"results"`
}

CollectionResponsePipelineStage defines model for CollectionResponsePipelineStage.

type CreateObjectTypeJSONBody 

type CreateObjectTypeJSONBody PipelineInput

CreateObjectTypeJSONBody defines parameters for CreateObjectType.

type CreateObjectTypeJSONRequestBody 

type CreateObjectTypeJSONRequestBody CreateObjectTypeJSONBody

CreateObjectTypeJSONRequestBody defines body for CreateObjectType for application/json ContentType.

type CreateObjectTypeResponse 

type CreateObjectTypeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *Pipeline
}

func (CreateObjectTypeResponse) Status 

func (r CreateObjectTypeResponse) Status() string

Status returns HTTPResponse.Status

func (CreateObjectTypeResponse) StatusCode 

func (r CreateObjectTypeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateStagesJSONBody 

type CreateStagesJSONBody PipelineStageInput

CreateStagesJSONBody defines parameters for CreateStages.

type CreateStagesJSONRequestBody 

type CreateStagesJSONRequestBody CreateStagesJSONBody

CreateStagesJSONRequestBody defines body for CreateStages for application/json ContentType.

type CreateStagesResponse 

type CreateStagesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *PipelineStage
}

func (CreateStagesResponse) Status 

func (r CreateStagesResponse) Status() string

Status returns HTTPResponse.Status

func (CreateStagesResponse) StatusCode 

func (r CreateStagesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Error 

type Error struct {
	// The error category
	Category string `json:"category"`

	// Context about the error condition
	Context *Error_Context `json:"context,omitempty"`

	// A unique identifier for the request. Include this value with any error reports or support tickets
	CorrelationId string `json:"correlationId"`

	// further information about the error
	Errors *[]ErrorDetail `json:"errors,omitempty"`

	// A map of link names to associated URIs containing documentation about the error or recommended remediation steps
	Links *Error_Links `json:"links,omitempty"`

	// A human readable message describing the error along with remediation steps where appropriate
	Message string `json:"message"`

	// A specific category that contains more specific detail about the error
	SubCategory *string `json:"subCategory,omitempty"`
}

Error defines model for Error.

type ErrorDetail 

type ErrorDetail struct {
	// The status code associated with the error detail
	Code *string `json:"code,omitempty"`

	// Context about the error condition
	Context *ErrorDetail_Context `json:"context,omitempty"`

	// The name of the field or parameter in which the error was found.
	In *string `json:"in,omitempty"`

	// A human readable message describing the error along with remediation steps where appropriate
	Message string `json:"message"`

	// A specific category that contains more specific detail about the error
	SubCategory *string `json:"subCategory,omitempty"`
}

ErrorDetail defines model for ErrorDetail.

type ErrorDetail_Context 

type ErrorDetail_Context struct {
	AdditionalProperties map[string][]string `json:"-"`
}

Context about the error condition

func (ErrorDetail_Context) Get 

func (a ErrorDetail_Context) Get(fieldName string) (value []string, found bool)

Getter for additional properties for ErrorDetail_Context. Returns the specified element and whether it was found

func (ErrorDetail_Context) MarshalJSON 

func (a ErrorDetail_Context) MarshalJSON() ([]byte, error)

Override default JSON handling for ErrorDetail_Context to handle AdditionalProperties

func (*ErrorDetail_Context) Set 

func (a *ErrorDetail_Context) Set(fieldName string, value []string)

Setter for additional properties for ErrorDetail_Context

func (*ErrorDetail_Context) UnmarshalJSON 

func (a *ErrorDetail_Context) UnmarshalJSON(b []byte) error

Override default JSON handling for ErrorDetail_Context to handle AdditionalProperties

type Error_Context 

type Error_Context struct {
	AdditionalProperties map[string][]string `json:"-"`
}

Context about the error condition

func (Error_Context) Get 

func (a Error_Context) Get(fieldName string) (value []string, found bool)

Getter for additional properties for Error_Context. Returns the specified element and whether it was found

func (Error_Context) MarshalJSON 

func (a Error_Context) MarshalJSON() ([]byte, error)

Override default JSON handling for Error_Context to handle AdditionalProperties

func (*Error_Context) Set 

func (a *Error_Context) Set(fieldName string, value []string)

Setter for additional properties for Error_Context

func (*Error_Context) UnmarshalJSON 

func (a *Error_Context) UnmarshalJSON(b []byte) error

Override default JSON handling for Error_Context to handle AdditionalProperties 

type Error_Links struct {
	AdditionalProperties map[string]string `json:"-"`
}

A map of link names to associated URIs containing documentation about the error or recommended remediation steps

func (Error_Links) Get 

func (a Error_Links) Get(fieldName string) (value string, found bool)

Getter for additional properties for Error_Links. Returns the specified element and whether it was found

func (Error_Links) MarshalJSON 

func (a Error_Links) MarshalJSON() ([]byte, error)

Override default JSON handling for Error_Links to handle AdditionalProperties

func (*Error_Links) Set 

func (a *Error_Links) Set(fieldName string, value string)

Setter for additional properties for Error_Links

func (*Error_Links) UnmarshalJSON 

func (a *Error_Links) UnmarshalJSON(b []byte) error

Override default JSON handling for Error_Links to handle AdditionalProperties

type GetAllObjectTypeParams 

type GetAllObjectTypeParams struct {
	// Whether to return only results that have been archived.
	Archived *bool `json:"archived,omitempty"`
}

GetAllObjectTypeParams defines parameters for GetAllObjectType.

type GetAllObjectTypeResponse 

type GetAllObjectTypeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CollectionResponsePipeline
}

func (GetAllObjectTypeResponse) Status 

func (r GetAllObjectTypeResponse) Status() string

Status returns HTTPResponse.Status

func (GetAllObjectTypeResponse) StatusCode 

func (r GetAllObjectTypeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAllStagesParams 

type GetAllStagesParams struct {
	// Whether to return only results that have been archived.
	Archived *bool `json:"archived,omitempty"`
}

GetAllStagesParams defines parameters for GetAllStages.

type GetAllStagesResponse 

type GetAllStagesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CollectionResponsePipelineStage
}

func (GetAllStagesResponse) Status 

func (r GetAllStagesResponse) Status() string

Status returns HTTPResponse.Status

func (GetAllStagesResponse) StatusCode 

func (r GetAllStagesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetPipelineParams 

type GetPipelineParams struct {
	// Whether to return only results that have been archived.
	Archived *bool `json:"archived,omitempty"`
}

GetPipelineParams defines parameters for GetPipeline.

type GetPipelineResponse 

type GetPipelineResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Pipeline
}

func (GetPipelineResponse) Status 

func (r GetPipelineResponse) Status() string

Status returns HTTPResponse.Status

func (GetPipelineResponse) StatusCode 

func (r GetPipelineResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetStageParams 

type GetStageParams struct {
	// Whether to return only results that have been archived.
	Archived *bool `json:"archived,omitempty"`
}

GetStageParams defines parameters for GetStage.

type GetStageResponse 

type GetStageResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PipelineStage
}

func (GetStageResponse) Status 

func (r GetStageResponse) Status() string

Status returns HTTPResponse.Status

func (GetStageResponse) StatusCode 

func (r GetStageResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type NextPage 

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

NextPage defines model for NextPage.

type Paging 

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

Paging defines model for Paging.

type Pipeline 

type Pipeline struct {
	// Whether the pipeline is archived.
	Archived bool `json:"archived"`

	// 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 created. The default pipelines will have createdAt = 0.
	CreatedAt time.Time `json:"createdAt"`

	// 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"`

	// A unique label used to organize pipelines in HubSpot's UI
	Label string `json:"label"`

	// 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 last updated.
	UpdatedAt time.Time `json:"updatedAt"`
}

A pipeline definition.

type PipelineInput 

type PipelineInput struct {
	// 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 label used to organize pipelines in HubSpot's UI
	Label string `json:"label"`

	// Pipeline stage inputs used to create the new or replacement pipeline.
	Stages []PipelineStageInput `json:"stages"`
}

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

type PipelinePatchInput 

type PipelinePatchInput struct {
	// 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"`

	// 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"`

	// A unique label used to organize pipelines in HubSpot's UI
	Label *string `json:"label,omitempty"`
}

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

type PipelineStage 

type PipelineStage struct {
	// Whether the pipeline is archived.
	Archived bool `json:"archived"`

	// 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 created. The stages on default pipelines will have createdAt = 0.
	CreatedAt time.Time `json:"createdAt"`

	// 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 unique identifier generated by HubSpot that can be used to retrieve and update the pipeline stage.
	Id string `json:"id"`

	// 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"`

	// 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 PipelineStage_Metadata `json:"metadata"`

	// The date the pipeline stage was last updated.
	UpdatedAt time.Time `json:"updatedAt"`
}

A pipeline stage definition.

type PipelineStageInput 

type PipelineStageInput struct {
	// 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 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"`

	// 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 PipelineStageInput_Metadata `json:"metadata"`
}

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

type PipelineStageInput_Metadata 

type PipelineStageInput_Metadata struct {
	AdditionalProperties map[string]string `json:"-"`
}

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`.

func (PipelineStageInput_Metadata) Get 

func (a PipelineStageInput_Metadata) Get(fieldName string) (value string, found bool)

Getter for additional properties for PipelineStageInput_Metadata. Returns the specified element and whether it was found

func (PipelineStageInput_Metadata) MarshalJSON 

func (a PipelineStageInput_Metadata) MarshalJSON() ([]byte, error)

Override default JSON handling for PipelineStageInput_Metadata to handle AdditionalProperties

func (*PipelineStageInput_Metadata) Set 

func (a *PipelineStageInput_Metadata) Set(fieldName string, value string)

Setter for additional properties for PipelineStageInput_Metadata

func (*PipelineStageInput_Metadata) UnmarshalJSON 

func (a *PipelineStageInput_Metadata) UnmarshalJSON(b []byte) error

Override default JSON handling for PipelineStageInput_Metadata to handle AdditionalProperties

type PipelineStagePatchInput 

type PipelineStagePatchInput struct {
	// 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 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"`

	// 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 PipelineStagePatchInput_Metadata `json:"metadata"`
}

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

type PipelineStagePatchInput_Metadata 

type PipelineStagePatchInput_Metadata struct {
	AdditionalProperties map[string]string `json:"-"`
}

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`.

func (PipelineStagePatchInput_Metadata) Get 

func (a PipelineStagePatchInput_Metadata) Get(fieldName string) (value string, found bool)

Getter for additional properties for PipelineStagePatchInput_Metadata. Returns the specified element and whether it was found

func (PipelineStagePatchInput_Metadata) MarshalJSON 

func (a PipelineStagePatchInput_Metadata) MarshalJSON() ([]byte, error)

Override default JSON handling for PipelineStagePatchInput_Metadata to handle AdditionalProperties

func (*PipelineStagePatchInput_Metadata) Set 

func (a *PipelineStagePatchInput_Metadata) Set(fieldName string, value string)

Setter for additional properties for PipelineStagePatchInput_Metadata

func (*PipelineStagePatchInput_Metadata) UnmarshalJSON 

func (a *PipelineStagePatchInput_Metadata) UnmarshalJSON(b []byte) error

Override default JSON handling for PipelineStagePatchInput_Metadata to handle AdditionalProperties

type PipelineStage_Metadata 

type PipelineStage_Metadata struct {
	AdditionalProperties map[string]string `json:"-"`
}

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`.

func (PipelineStage_Metadata) Get 

func (a PipelineStage_Metadata) Get(fieldName string) (value string, found bool)

Getter for additional properties for PipelineStage_Metadata. Returns the specified element and whether it was found

func (PipelineStage_Metadata) MarshalJSON 

func (a PipelineStage_Metadata) MarshalJSON() ([]byte, error)

Override default JSON handling for PipelineStage_Metadata to handle AdditionalProperties

func (*PipelineStage_Metadata) Set 

func (a *PipelineStage_Metadata) Set(fieldName string, value string)

Setter for additional properties for PipelineStage_Metadata

func (*PipelineStage_Metadata) UnmarshalJSON 

func (a *PipelineStage_Metadata) UnmarshalJSON(b []byte) error

Override default JSON handling for PipelineStage_Metadata to handle AdditionalProperties

type ReplacePipelineJSONBody 

type ReplacePipelineJSONBody PipelineInput

ReplacePipelineJSONBody defines parameters for ReplacePipeline.

type ReplacePipelineJSONRequestBody 

type ReplacePipelineJSONRequestBody ReplacePipelineJSONBody

ReplacePipelineJSONRequestBody defines body for ReplacePipeline for application/json ContentType.

type ReplacePipelineResponse 

type ReplacePipelineResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Pipeline
}

func (ReplacePipelineResponse) Status 

func (r ReplacePipelineResponse) Status() string

Status returns HTTPResponse.Status

func (ReplacePipelineResponse) StatusCode 

func (r ReplacePipelineResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ReplaceStageJSONBody 

type ReplaceStageJSONBody PipelineStageInput

ReplaceStageJSONBody defines parameters for ReplaceStage.

type ReplaceStageJSONRequestBody 

type ReplaceStageJSONRequestBody ReplaceStageJSONBody

ReplaceStageJSONRequestBody defines body for ReplaceStage for application/json ContentType.

type ReplaceStageResponse 

type ReplaceStageResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PipelineStage
}

func (ReplaceStageResponse) Status 

func (r ReplaceStageResponse) Status() string

Status returns HTTPResponse.Status

func (ReplaceStageResponse) StatusCode 

func (r ReplaceStageResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdatePipelineJSONBody 

type UpdatePipelineJSONBody PipelinePatchInput

UpdatePipelineJSONBody defines parameters for UpdatePipeline.

type UpdatePipelineJSONRequestBody 

type UpdatePipelineJSONRequestBody UpdatePipelineJSONBody

UpdatePipelineJSONRequestBody defines body for UpdatePipeline for application/json ContentType.

type UpdatePipelineParams 

type UpdatePipelineParams struct {
	// Whether to return only results that have been archived.
	Archived *bool `json:"archived,omitempty"`
}

UpdatePipelineParams defines parameters for UpdatePipeline.

type UpdatePipelineResponse 

type UpdatePipelineResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Pipeline
}

func (UpdatePipelineResponse) Status 

func (r UpdatePipelineResponse) Status() string

Status returns HTTPResponse.Status

func (UpdatePipelineResponse) StatusCode 

func (r UpdatePipelineResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateStageJSONBody 

type UpdateStageJSONBody PipelineStagePatchInput

UpdateStageJSONBody defines parameters for UpdateStage.

type UpdateStageJSONRequestBody 

type UpdateStageJSONRequestBody UpdateStageJSONBody

UpdateStageJSONRequestBody defines body for UpdateStage for application/json ContentType.

type UpdateStageParams 

type UpdateStageParams struct {
	// Whether to return only results that have been archived.
	Archived *bool `json:"archived,omitempty"`
}

UpdateStageParams defines parameters for UpdateStage.

type UpdateStageResponse 

type UpdateStageResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PipelineStage
}

func (UpdateStageResponse) Status 

func (r UpdateStageResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateStageResponse) StatusCode 

func (r UpdateStageResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

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.