lineItems

package
v0.0.19 Latest Latest
Warning

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

 Go to latest Published: Jun 25, 2025 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Overview

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

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.4.1 DO NOT EDIT.

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

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.4.1 DO NOT EDIT.

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

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.4.1 DO NOT EDIT.

Index

Constants

View Source 
const (
	Oauth2Scopes = "oauth2.Scopes"
)

Variables

This section is empty.

Functions

func GetSwagger 

func GetSwagger() (swagger *openapi3.T, err error)

GetSwagger returns the Swagger specification corresponding to the generated code in this file. The external references of Swagger specification are resolved. The logic of resolving external references is tightly connected to "import-mapping" feature. Externally referenced files must be embedded in the corresponding golang packages. Urls can be supported but this task was out of the scope.

func NewBatchCreateLineItemsRequest added in v0.0.17 

func NewBatchCreateLineItemsRequest(server string, body BatchCreateLineItemsJSONRequestBody) (*http.Request, error)

NewBatchCreateLineItemsRequest calls the generic BatchCreateLineItems builder with application/json body

func NewBatchCreateLineItemsRequestWithBody added in v0.0.17 

func NewBatchCreateLineItemsRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewBatchCreateLineItemsRequestWithBody generates requests for BatchCreateLineItems with any type of body

func NewCreateLineItemRequest 

func NewCreateLineItemRequest(server string, body CreateLineItemJSONRequestBody) (*http.Request, error)

NewCreateLineItemRequest calls the generic CreateLineItem builder with application/json body

func NewCreateLineItemRequestWithBody 

func NewCreateLineItemRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateLineItemRequestWithBody generates requests for CreateLineItem with any type of body

func NewDeleteLineItemByIdRequest 

func NewDeleteLineItemByIdRequest(server string, lineItemId string) (*http.Request, error)

NewDeleteLineItemByIdRequest generates requests for DeleteLineItemById

func NewGetLineItemByIdRequest 

func NewGetLineItemByIdRequest(server string, lineItemId string, params *GetLineItemByIdParams) (*http.Request, error)

NewGetLineItemByIdRequest generates requests for GetLineItemById

func NewGetLineItemsRequest 

func NewGetLineItemsRequest(server string, params *GetLineItemsParams) (*http.Request, error)

NewGetLineItemsRequest generates requests for GetLineItems

func NewSearchLineItemsRequest 

func NewSearchLineItemsRequest(server string, body SearchLineItemsJSONRequestBody) (*http.Request, error)

NewSearchLineItemsRequest calls the generic SearchLineItems builder with application/json body

func NewSearchLineItemsRequestWithBody 

func NewSearchLineItemsRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewSearchLineItemsRequestWithBody generates requests for SearchLineItems with any type of body

func NewUpdateLineItemRequest 

func NewUpdateLineItemRequest(server string, lineItemId string, body UpdateLineItemJSONRequestBody) (*http.Request, error)

NewUpdateLineItemRequest calls the generic UpdateLineItem builder with application/json body

func NewUpdateLineItemRequestWithBody 

func NewUpdateLineItemRequestWithBody(server string, lineItemId string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateLineItemRequestWithBody generates requests for UpdateLineItem with any type of body

func PathToRawSpec 

func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)

Constructs a synthetic filesystem for resolving external references when loading openapi specifications.

func RegisterHandlers 

func RegisterHandlers(router EchoRouter, si ServerInterface)

RegisterHandlers adds each server route to the EchoRouter.

func RegisterHandlersWithBaseURL 

func RegisterHandlersWithBaseURL(router EchoRouter, si ServerInterface, baseURL string)

Registers handlers, and prepends BaseURL to the paths, so that the paths can be served under a prefix.

Types

type Archived 

type Archived = bool

Archived defines model for Archived.

type AssociationResponse 

type AssociationResponse struct {
	// Id The ID of the associated object.
	Id *string `json:"id,omitempty"`

	// Type The type of association.
	Type *string `json:"type,omitempty"`
}

AssociationResponse defines model for AssociationResponse.

type AssociationSpec added in v0.0.17 

type AssociationSpec struct {
	To    *AssociationTarget `json:"to,omitempty"`
	Types *[]AssociationType `json:"types,omitempty"`
}

AssociationSpec defines model for AssociationSpec.

type AssociationTarget added in v0.0.17 

type AssociationTarget struct {
	Id *string `json:"id,omitempty"`
}

AssociationTarget defines model for AssociationTarget.

type AssociationType added in v0.0.17 

type AssociationType struct {
	AssociationCategory AssociationTypeAssociationCategory `json:"associationCategory"`
	AssociationTypeId   int32                              `json:"associationTypeId"`
}

AssociationType defines model for AssociationType.

type AssociationTypeAssociationCategory added in v0.0.17 

type AssociationTypeAssociationCategory string

AssociationTypeAssociationCategory defines model for AssociationType.AssociationCategory. 

const (
	HUBSPOTDEFINED    AssociationTypeAssociationCategory = "HUBSPOT_DEFINED"
	INTEGRATORDEFINED AssociationTypeAssociationCategory = "INTEGRATOR_DEFINED"
	USERDEFINED       AssociationTypeAssociationCategory = "USER_DEFINED"
)

Defines values for AssociationTypeAssociationCategory.

type Associations 

type Associations = []string

Associations defines model for Associations.

type BatchCreateLineItemsJSONRequestBody added in v0.0.17 

type BatchCreateLineItemsJSONRequestBody = BatchCreateLineItemsRequest

BatchCreateLineItemsJSONRequestBody defines body for BatchCreateLineItems for application/json ContentType.

type BatchCreateLineItemsRequest added in v0.0.17 

type BatchCreateLineItemsRequest struct {
	Inputs []LineItemCreateRequest `json:"inputs"`
}

BatchCreateLineItemsRequest defines model for BatchCreateLineItemsRequest.

type BatchCreateLineItemsResponse added in v0.0.17 

type BatchCreateLineItemsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *BatchResponseLineItems
	JSON400      *ErrorResponse
}

func ParseBatchCreateLineItemsResponse added in v0.0.17 

func ParseBatchCreateLineItemsResponse(rsp *http.Response) (*BatchCreateLineItemsResponse, error)

ParseBatchCreateLineItemsResponse parses an HTTP response from a BatchCreateLineItemsWithResponse call

func (BatchCreateLineItemsResponse) Status added in v0.0.17 

func (r BatchCreateLineItemsResponse) Status() string

Status returns HTTPResponse.Status

func (BatchCreateLineItemsResponse) StatusCode added in v0.0.17 

func (r BatchCreateLineItemsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type BatchResponseLineItems added in v0.0.17 

type BatchResponseLineItems struct {
	CompletedAt *time.Time                    `json:"completedAt,omitempty"`
	Errors      *[]Error                      `json:"errors,omitempty"`
	NumErrors   *int                          `json:"numErrors,omitempty"`
	RequestedAt *time.Time                    `json:"requestedAt,omitempty"`
	Results     *[]LineItemResponse           `json:"results,omitempty"`
	StartedAt   *time.Time                    `json:"startedAt,omitempty"`
	Status      *BatchResponseLineItemsStatus `json:"status,omitempty"`
}

BatchResponseLineItems defines model for BatchResponseLineItems.

type BatchResponseLineItemsStatus added in v0.0.17 

type BatchResponseLineItemsStatus string

BatchResponseLineItemsStatus defines model for BatchResponseLineItems.Status. 

const (
	CANCELED   BatchResponseLineItemsStatus = "CANCELED"
	COMPLETE   BatchResponseLineItemsStatus = "COMPLETE"
	PENDING    BatchResponseLineItemsStatus = "PENDING"
	PROCESSING BatchResponseLineItemsStatus = "PROCESSING"
)

Defines values for BatchResponseLineItemsStatus.

type Client 

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient 

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) BatchCreateLineItems added in v0.0.17 

func (c *Client) BatchCreateLineItems(ctx context.Context, body BatchCreateLineItemsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) BatchCreateLineItemsWithBody added in v0.0.17 

func (c *Client) BatchCreateLineItemsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateLineItem 

func (c *Client) CreateLineItem(ctx context.Context, body CreateLineItemJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateLineItemWithBody 

func (c *Client) CreateLineItemWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteLineItemById 

func (c *Client) DeleteLineItemById(ctx context.Context, lineItemId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetLineItemById 

func (c *Client) GetLineItemById(ctx context.Context, lineItemId string, params *GetLineItemByIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetLineItems 

func (c *Client) GetLineItems(ctx context.Context, params *GetLineItemsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SearchLineItems 

func (c *Client) SearchLineItems(ctx context.Context, body SearchLineItemsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SearchLineItemsWithBody 

func (c *Client) SearchLineItemsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateLineItem 

func (c *Client) UpdateLineItem(ctx context.Context, lineItemId string, body UpdateLineItemJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateLineItemWithBody 

func (c *Client) UpdateLineItemWithBody(ctx context.Context, lineItemId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface 

type ClientInterface interface {
	// GetLineItems request
	GetLineItems(ctx context.Context, params *GetLineItemsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateLineItemWithBody request with any body
	CreateLineItemWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateLineItem(ctx context.Context, body CreateLineItemJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// BatchCreateLineItemsWithBody request with any body
	BatchCreateLineItemsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	BatchCreateLineItems(ctx context.Context, body BatchCreateLineItemsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SearchLineItemsWithBody request with any body
	SearchLineItemsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	SearchLineItems(ctx context.Context, body SearchLineItemsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteLineItemById request
	DeleteLineItemById(ctx context.Context, lineItemId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetLineItemById request
	GetLineItemById(ctx context.Context, lineItemId string, params *GetLineItemByIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateLineItemWithBody request with any body
	UpdateLineItemWithBody(ctx context.Context, lineItemId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateLineItem(ctx context.Context, lineItemId string, body UpdateLineItemJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption 

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL 

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient 

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn 

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

type ClientWithResponses 

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses 

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) BatchCreateLineItemsWithBodyWithResponse added in v0.0.17 

func (c *ClientWithResponses) BatchCreateLineItemsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*BatchCreateLineItemsResponse, error)

BatchCreateLineItemsWithBodyWithResponse request with arbitrary body returning *BatchCreateLineItemsResponse

func (*ClientWithResponses) BatchCreateLineItemsWithResponse added in v0.0.17 

func (c *ClientWithResponses) BatchCreateLineItemsWithResponse(ctx context.Context, body BatchCreateLineItemsJSONRequestBody, reqEditors ...RequestEditorFn) (*BatchCreateLineItemsResponse, error)

func (*ClientWithResponses) CreateLineItemWithBodyWithResponse 

func (c *ClientWithResponses) CreateLineItemWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateLineItemResponse, error)

CreateLineItemWithBodyWithResponse request with arbitrary body returning *CreateLineItemResponse

func (*ClientWithResponses) CreateLineItemWithResponse 

func (c *ClientWithResponses) CreateLineItemWithResponse(ctx context.Context, body CreateLineItemJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateLineItemResponse, error)

func (*ClientWithResponses) DeleteLineItemByIdWithResponse 

func (c *ClientWithResponses) DeleteLineItemByIdWithResponse(ctx context.Context, lineItemId string, reqEditors ...RequestEditorFn) (*DeleteLineItemByIdResponse, error)

DeleteLineItemByIdWithResponse request returning *DeleteLineItemByIdResponse

func (*ClientWithResponses) GetLineItemByIdWithResponse 

func (c *ClientWithResponses) GetLineItemByIdWithResponse(ctx context.Context, lineItemId string, params *GetLineItemByIdParams, reqEditors ...RequestEditorFn) (*GetLineItemByIdResponse, error)

GetLineItemByIdWithResponse request returning *GetLineItemByIdResponse

func (*ClientWithResponses) GetLineItemsWithResponse 

func (c *ClientWithResponses) GetLineItemsWithResponse(ctx context.Context, params *GetLineItemsParams, reqEditors ...RequestEditorFn) (*GetLineItemsResponse, error)

GetLineItemsWithResponse request returning *GetLineItemsResponse

func (*ClientWithResponses) SearchLineItemsWithBodyWithResponse 

func (c *ClientWithResponses) SearchLineItemsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SearchLineItemsResponse, error)

SearchLineItemsWithBodyWithResponse request with arbitrary body returning *SearchLineItemsResponse

func (*ClientWithResponses) SearchLineItemsWithResponse 

func (c *ClientWithResponses) SearchLineItemsWithResponse(ctx context.Context, body SearchLineItemsJSONRequestBody, reqEditors ...RequestEditorFn) (*SearchLineItemsResponse, error)

func (*ClientWithResponses) UpdateLineItemWithBodyWithResponse 

func (c *ClientWithResponses) UpdateLineItemWithBodyWithResponse(ctx context.Context, lineItemId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateLineItemResponse, error)

UpdateLineItemWithBodyWithResponse request with arbitrary body returning *UpdateLineItemResponse

func (*ClientWithResponses) UpdateLineItemWithResponse 

func (c *ClientWithResponses) UpdateLineItemWithResponse(ctx context.Context, lineItemId string, body UpdateLineItemJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateLineItemResponse, error)

type ClientWithResponsesInterface 

type ClientWithResponsesInterface interface {
	// GetLineItemsWithResponse request
	GetLineItemsWithResponse(ctx context.Context, params *GetLineItemsParams, reqEditors ...RequestEditorFn) (*GetLineItemsResponse, error)

	// CreateLineItemWithBodyWithResponse request with any body
	CreateLineItemWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateLineItemResponse, error)

	CreateLineItemWithResponse(ctx context.Context, body CreateLineItemJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateLineItemResponse, error)

	// BatchCreateLineItemsWithBodyWithResponse request with any body
	BatchCreateLineItemsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*BatchCreateLineItemsResponse, error)

	BatchCreateLineItemsWithResponse(ctx context.Context, body BatchCreateLineItemsJSONRequestBody, reqEditors ...RequestEditorFn) (*BatchCreateLineItemsResponse, error)

	// SearchLineItemsWithBodyWithResponse request with any body
	SearchLineItemsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SearchLineItemsResponse, error)

	SearchLineItemsWithResponse(ctx context.Context, body SearchLineItemsJSONRequestBody, reqEditors ...RequestEditorFn) (*SearchLineItemsResponse, error)

	// DeleteLineItemByIdWithResponse request
	DeleteLineItemByIdWithResponse(ctx context.Context, lineItemId string, reqEditors ...RequestEditorFn) (*DeleteLineItemByIdResponse, error)

	// GetLineItemByIdWithResponse request
	GetLineItemByIdWithResponse(ctx context.Context, lineItemId string, params *GetLineItemByIdParams, reqEditors ...RequestEditorFn) (*GetLineItemByIdResponse, error)

	// UpdateLineItemWithBodyWithResponse request with any body
	UpdateLineItemWithBodyWithResponse(ctx context.Context, lineItemId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateLineItemResponse, error)

	UpdateLineItemWithResponse(ctx context.Context, lineItemId string, body UpdateLineItemJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateLineItemResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type CreateLineItemJSONRequestBody 

type CreateLineItemJSONRequestBody = LineItemCreateRequest

CreateLineItemJSONRequestBody defines body for CreateLineItem for application/json ContentType.

type CreateLineItemResponse 

type CreateLineItemResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *struct {
		// Archived Whether the customer is archived or not.
		Archived bool `json:"archived,omitempty"`

		// ArchivedAt Timestamp when the lineItem was archived.
		ArchivedAt time.Time `json:"archivedAt,omitempty"`

		// CreatedAt Timestamp when the lineItem was created.
		CreatedAt time.Time `json:"createdAt,omitempty"`

		// Id Unique ID of the created lineItem.
		Id string `json:"id,omitempty"`

		// Properties Properties of the created lineItem.
		Properties map[string]interface{} `json:"properties,omitempty"`

		// PropertiesWithHistory A map of the lineItem's properties including historical values.
		PropertiesWithHistory map[string][]PropertyHistory `json:"propertiesWithHistory,omitempty"`

		// UpdatedAt Timestamp when the lineItem was last updated.
		UpdatedAt time.Time `json:"updatedAt,omitempty"`
	}
	JSON400 *ErrorResponse
}

func ParseCreateLineItemResponse 

func ParseCreateLineItemResponse(rsp *http.Response) (*CreateLineItemResponse, error)

ParseCreateLineItemResponse parses an HTTP response from a CreateLineItemWithResponse call

func (CreateLineItemResponse) Status 

func (r CreateLineItemResponse) Status() string

Status returns HTTPResponse.Status

func (CreateLineItemResponse) StatusCode 

func (r CreateLineItemResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteLineItemByIdResponse 

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

func ParseDeleteLineItemByIdResponse 

func ParseDeleteLineItemByIdResponse(rsp *http.Response) (*DeleteLineItemByIdResponse, error)

ParseDeleteLineItemByIdResponse parses an HTTP response from a DeleteLineItemByIdWithResponse call

func (DeleteLineItemByIdResponse) Status 

func (r DeleteLineItemByIdResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteLineItemByIdResponse) StatusCode 

func (r DeleteLineItemByIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type EchoRouter 

type EchoRouter interface {
	CONNECT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	DELETE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	GET(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	HEAD(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	OPTIONS(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	PATCH(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	POST(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	PUT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	TRACE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
}

This is a simple interface which specifies echo.Route addition functions which are present on both echo.Echo and echo.Group, since we want to allow using either of them for path registration

type Error added in v0.0.17 

type Error struct {
	Category      *string            `json:"category,omitempty"`
	Context       *ErrorContext      `json:"context,omitempty"`
	CorrelationId *string            `json:"correlationId,omitempty"`
	Errors        *[]ErrorDetail     `json:"errors,omitempty"`
	Links         *map[string]string `json:"links,omitempty"`
	Message       *string            `json:"message,omitempty"`
	SubCategory   *string            `json:"subCategory,omitempty"`
}

Error defines model for Error.

type ErrorContext added in v0.0.17 

type ErrorContext struct {
	InvalidPropertyName *[]string `json:"invalidPropertyName,omitempty"`
	MissingScopes       *[]string `json:"missingScopes,omitempty"`
}

ErrorContext defines model for ErrorContext.

type ErrorDetail added in v0.0.17 

type ErrorDetail struct {
	Code        *string                 `json:"code,omitempty"`
	Context     *map[string]interface{} `json:"context,omitempty"`
	In          *string                 `json:"in,omitempty"`
	Message     *string                 `json:"message,omitempty"`
	SubCategory *string                 `json:"subCategory,omitempty"`
}

ErrorDetail defines model for ErrorDetail.

type ErrorResponse added in v0.0.17 

type ErrorResponse = Error

ErrorResponse defines model for ErrorResponse.

type Filter 

type Filter struct {
	// HighValue A high-value filter criterion.
	HighValue string `json:"highValue,omitempty"`

	// Operator defines model for Filter.Operator
	Operator FilterOperator `json:"operator,omitempty"`

	// PropertyName The property name to filter by.
	PropertyName string `json:"propertyName,omitempty"`

	// Value A single value to match for the property.
	Value string `json:"value,omitempty"`

	// Values List of values to match for the property.
	Values []string `json:"values,omitempty"`
}

Filter defines model for Filter.

type FilterGroups 

type FilterGroups struct {
	Filters []Filter `json:"filters,omitempty"`
}

FilterGroups defines model for FilterGroups.

type FilterOperator 

type FilterOperator string

FilterOperator defines model for Filter.Operator 

const (
	CONTAINSTOKEN    FilterOperator = "CONTAINS_TOKEN"
	EQ               FilterOperator = "EQ"
	GT               FilterOperator = "GT"
	GTE              FilterOperator = "GTE"
	HASPROPERTY      FilterOperator = "HAS_PROPERTY"
	LT               FilterOperator = "LT"
	LTE              FilterOperator = "LTE"
	NEQ              FilterOperator = "NEQ"
	NOTCONTAINSTOKEN FilterOperator = "NOT_CONTAINS_TOKEN"
	NOTHASPROPERTY   FilterOperator = "NOT_HAS_PROPERTY"
)

Defines values for FilterOperator.

type GetLineItemByIdParams 

type GetLineItemByIdParams struct {
	// IdProperty The property to use as the ID.
	IdProperty *string `form:"idProperty,omitempty" json:"idProperty,omitempty"`

	// Properties Comma-separated list of properties to include in the response.
	// If a specified property is not present, it will be ignored.
	Properties *Properties `form:"properties,omitempty" json:"properties,omitempty"`

	// PropertiesWithHistory Comma-separated list of properties to include with their historical values.
	// Historical data reduces the maximum number of objects returned per request.
	PropertiesWithHistory *PropertiesWithHistory `form:"propertiesWithHistory,omitempty" json:"propertiesWithHistory,omitempty"`

	// Associations Comma-separated list of object types to retrieve associated IDs for.
	// Nonexistent associations will be ignored.
	Associations *Associations `form:"associations,omitempty" json:"associations,omitempty"`

	// Archived Include only archived results.
	Archived *Archived `form:"archived,omitempty" json:"archived,omitempty"`
}

GetLineItemByIdParams defines parameters for GetLineItemById.

type GetLineItemByIdResponse 

type GetLineItemByIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *LineItemResponse
}

func ParseGetLineItemByIdResponse 

func ParseGetLineItemByIdResponse(rsp *http.Response) (*GetLineItemByIdResponse, error)

ParseGetLineItemByIdResponse parses an HTTP response from a GetLineItemByIdWithResponse call

func (GetLineItemByIdResponse) Status 

func (r GetLineItemByIdResponse) Status() string

Status returns HTTPResponse.Status

func (GetLineItemByIdResponse) StatusCode 

func (r GetLineItemByIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetLineItemsParams 

type GetLineItemsParams struct {
	// Limit Maximum number of results per page.
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`

	// After Cursor token for the next page of results.
	After *string `form:"after,omitempty" json:"after,omitempty"`

	// Properties Comma-separated list of properties to include in the response.
	// If a specified property is not present, it will be ignored.
	Properties *Properties `form:"properties,omitempty" json:"properties,omitempty"`

	// PropertiesWithHistory Comma-separated list of properties to include with their historical values.
	// Historical data reduces the maximum number of objects returned per request.
	PropertiesWithHistory *PropertiesWithHistory `form:"propertiesWithHistory,omitempty" json:"propertiesWithHistory,omitempty"`

	// Associations Comma-separated list of object types to retrieve associated IDs for.
	// Nonexistent associations will be ignored.
	Associations *Associations `form:"associations,omitempty" json:"associations,omitempty"`

	// Archived Include only archived results.
	Archived *Archived `form:"archived,omitempty" json:"archived,omitempty"`
}

GetLineItemsParams defines parameters for GetLineItems.

type GetLineItemsResponse 

type GetLineItemsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *LineItemsResponse
}

func ParseGetLineItemsResponse 

func ParseGetLineItemsResponse(rsp *http.Response) (*GetLineItemsResponse, error)

ParseGetLineItemsResponse parses an HTTP response from a GetLineItemsWithResponse call

func (GetLineItemsResponse) Status 

func (r GetLineItemsResponse) Status() string

Status returns HTTPResponse.Status

func (GetLineItemsResponse) StatusCode 

func (r GetLineItemsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HttpRequestDoer 

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type LineItemCreateRequest added in v0.0.17 

type LineItemCreateRequest struct {
	Associations *[]AssociationSpec `json:"associations,omitempty"`

	// ObjectWriteTraceId Unique trace ID for the operation.
	ObjectWriteTraceId *string           `json:"objectWriteTraceId,omitempty"`
	Properties         map[string]string `json:"properties"`
}

LineItemCreateRequest defines model for LineItemCreateRequest.

type LineItemResponse 

type LineItemResponse struct {
	// Archived Indicates if the lineItem is archived.
	Archived bool `json:"archived,omitempty"`

	// ArchivedAt When the lineItem was archived.
	ArchivedAt time.Time `json:"archivedAt,omitempty"`

	// Associations A map of associated objects.
	Associations map[string]ObjectAssociationsResponse `json:"associations,omitempty"`

	// CreatedAt When the lineItem was created.
	CreatedAt time.Time `json:"createdAt,omitempty"`

	// Id Unique identifier for the lineItem.
	Id string `json:"id,omitempty"`

	// Properties A key-value map of the lineItem's properties.
	Properties map[string]string `json:"properties,omitempty"`

	// PropertiesWithHistory A map of the lineItem's properties including historical values.
	PropertiesWithHistory map[string][]PropertyHistory `json:"propertiesWithHistory,omitempty"`

	// UpdatedAt When the lineItem was last updated.
	UpdatedAt time.Time `json:"updatedAt,omitempty"`
}

LineItemResponse defines model for LineItemResponse.

type LineItemsResponse 

type LineItemsResponse struct {
	Paging  Paging             `json:"paging,omitempty"`
	Results []LineItemResponse `json:"results,omitempty"`
}

LineItemsResponse defines model for LineItemsResponse.

type ObjectAssociationsResponse 

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

ObjectAssociationsResponse defines model for ObjectAssociationsResponse.

type Paging 

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

Paging defines model for Paging.

type PagingNext 

type PagingNext struct {
	// After The cursor token for the next page of results.
	After string `json:"after,omitempty"`

	// Link The link for the next page of results.
	Link string `json:"link,omitempty"`
}

PagingNext defines model for PagingNext.

type Properties 

type Properties = []string

Properties defines model for Properties.

type PropertiesWithHistory 

type PropertiesWithHistory = []string

PropertiesWithHistory defines model for PropertiesWithHistory.

type PropertyHistory 

type PropertyHistory struct {
	// SourceId The source ID of the historical property value.
	SourceId string `json:"sourceId,omitempty"`

	// SourceLabel The source label for the historical property.
	SourceLabel string `json:"sourceLabel,omitempty"`

	// SourceType The source type of the historical property value.
	SourceType string `json:"sourceType,omitempty"`

	// Timestamp When the property value was set.
	Timestamp time.Time `json:"timestamp,omitempty"`

	// UpdatedByUserId The user ID who updated the property.
	UpdatedByUserId int `json:"updatedByUserId,omitempty"`

	// Value The historical value of the property.
	Value string `json:"value,omitempty"`
}

PropertyHistory defines model for PropertyHistory.

type RequestEditorFn 

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type SearchLineItemsJSONBody 

type SearchLineItemsJSONBody struct {
	After        *string        `json:"after,omitempty"`
	FilterGroups []FilterGroups `json:"filterGroups,omitempty"`
	Limit        *int           `json:"limit,omitempty"`
	Properties   *[]string      `json:"properties,omitempty"`
	Query        *string        `json:"query,omitempty"`
	Sorts        *[]string      `json:"sorts,omitempty"`
}

SearchLineItemsJSONBody defines parameters for SearchLineItems.

type SearchLineItemsJSONRequestBody 

type SearchLineItemsJSONRequestBody SearchLineItemsJSONBody

SearchLineItemsJSONRequestBody defines body for SearchLineItems for application/json ContentType.

type SearchLineItemsResponse 

type SearchLineItemsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *LineItemsResponse
}

func ParseSearchLineItemsResponse 

func ParseSearchLineItemsResponse(rsp *http.Response) (*SearchLineItemsResponse, error)

ParseSearchLineItemsResponse parses an HTTP response from a SearchLineItemsWithResponse call

func (SearchLineItemsResponse) Status 

func (r SearchLineItemsResponse) Status() string

Status returns HTTPResponse.Status

func (SearchLineItemsResponse) StatusCode 

func (r SearchLineItemsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ServerInterface 

type ServerInterface interface {
	// Retrieve a list of lineItems
	// (GET /crm/v3/objects/line_items)
	GetLineItems(ctx echo.Context, params GetLineItemsParams) error
	// Create a new lineItem
	// (POST /crm/v3/objects/line_items)
	CreateLineItem(ctx echo.Context) error
	// Batch create line items
	// (POST /crm/v3/objects/line_items/batch/create)
	BatchCreateLineItems(ctx echo.Context) error
	// Search for lineItems by email
	// (POST /crm/v3/objects/line_items/search)
	SearchLineItems(ctx echo.Context) error
	// Delete a lineItem
	// (DELETE /crm/v3/objects/line_items/{lineItemId})
	DeleteLineItemById(ctx echo.Context, lineItemId string) error
	// Get LineItem Details
	// (GET /crm/v3/objects/line_items/{lineItemId})
	GetLineItemById(ctx echo.Context, lineItemId string, params GetLineItemByIdParams) error
	// Update a lineItem
	// (PATCH /crm/v3/objects/line_items/{lineItemId})
	UpdateLineItem(ctx echo.Context, lineItemId string) error
}

ServerInterface represents all server handlers.

type ServerInterfaceWrapper 

type ServerInterfaceWrapper struct {
	Handler ServerInterface
}

ServerInterfaceWrapper converts echo contexts to parameters.

func (*ServerInterfaceWrapper) BatchCreateLineItems added in v0.0.17 

func (w *ServerInterfaceWrapper) BatchCreateLineItems(ctx echo.Context) error

BatchCreateLineItems converts echo context to params.

func (*ServerInterfaceWrapper) CreateLineItem 

func (w *ServerInterfaceWrapper) CreateLineItem(ctx echo.Context) error

CreateLineItem converts echo context to params.

func (*ServerInterfaceWrapper) DeleteLineItemById 

func (w *ServerInterfaceWrapper) DeleteLineItemById(ctx echo.Context) error

DeleteLineItemById converts echo context to params.

func (*ServerInterfaceWrapper) GetLineItemById 

func (w *ServerInterfaceWrapper) GetLineItemById(ctx echo.Context) error

GetLineItemById converts echo context to params.

func (*ServerInterfaceWrapper) GetLineItems 

func (w *ServerInterfaceWrapper) GetLineItems(ctx echo.Context) error

GetLineItems converts echo context to params.

func (*ServerInterfaceWrapper) SearchLineItems 

func (w *ServerInterfaceWrapper) SearchLineItems(ctx echo.Context) error

SearchLineItems converts echo context to params.

func (*ServerInterfaceWrapper) UpdateLineItem 

func (w *ServerInterfaceWrapper) UpdateLineItem(ctx echo.Context) error

UpdateLineItem converts echo context to params.

type UpdateLineItemJSONBody 

type UpdateLineItemJSONBody struct {
	// ObjectWriteTraceId Unique trace ID for the operation.
	ObjectWriteTraceId *string `json:"objectWriteTraceId,omitempty"`

	// Properties Key-value pairs representing the lineItem properties to update.
	Properties map[string]string `json:"properties"`
}

UpdateLineItemJSONBody defines parameters for UpdateLineItem.

type UpdateLineItemJSONRequestBody 

type UpdateLineItemJSONRequestBody UpdateLineItemJSONBody

UpdateLineItemJSONRequestBody defines body for UpdateLineItem for application/json ContentType.

type UpdateLineItemResponse 

type UpdateLineItemResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Archived Whether the customer is archived or not.
		Archived bool `json:"archived,omitempty"`

		// ArchivedAt Timestamp when the lineItem was archived.
		ArchivedAt time.Time `json:"archivedAt,omitempty"`

		// CreatedAt Timestamp when the lineItem was created.
		CreatedAt time.Time `json:"createdAt,omitempty"`

		// Id Unique ID of the updated lineItem.
		Id string `json:"id,omitempty"`

		// Properties Properties of the updated lineItem.
		Properties map[string]interface{} `json:"properties,omitempty"`

		// PropertiesWithHistory A map of the lineItem's properties including historical values.
		PropertiesWithHistory map[string][]PropertyHistory `json:"propertiesWithHistory,omitempty"`

		// UpdatedAt Timestamp when the lineItem was last updated.
		UpdatedAt time.Time `json:"updatedAt,omitempty"`
	}
}

func ParseUpdateLineItemResponse 

func ParseUpdateLineItemResponse(rsp *http.Response) (*UpdateLineItemResponse, error)

ParseUpdateLineItemResponse parses an HTTP response from a UpdateLineItemWithResponse call

func (UpdateLineItemResponse) Status 

func (r UpdateLineItemResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateLineItemResponse) StatusCode 

func (r UpdateLineItemResponse) 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.