properties

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: 14 Imported by: 0

Documentation

Overview

Package properties 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 properties 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 properties 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 NewBatchCreatePropertiesRequest 

func NewBatchCreatePropertiesRequest(server string, objectType ObjectType, body BatchCreatePropertiesJSONRequestBody) (*http.Request, error)

NewBatchCreatePropertiesRequest calls the generic BatchCreateProperties builder with application/json body

func NewBatchCreatePropertiesRequestWithBody 

func NewBatchCreatePropertiesRequestWithBody(server string, objectType ObjectType, contentType string, body io.Reader) (*http.Request, error)

NewBatchCreatePropertiesRequestWithBody generates requests for BatchCreateProperties with any type of body

func NewGetPropertiesRequest 

func NewGetPropertiesRequest(server string, objectType ObjectType) (*http.Request, error)

NewGetPropertiesRequest generates requests for GetProperties

func NewUpdatePropertyRequest added in v0.0.14 

func NewUpdatePropertyRequest(server string, objectType ObjectType, propertyName string, body UpdatePropertyJSONRequestBody) (*http.Request, error)

NewUpdatePropertyRequest calls the generic UpdateProperty builder with application/json body

func NewUpdatePropertyRequestWithBody added in v0.0.14 

func NewUpdatePropertyRequestWithBody(server string, objectType ObjectType, propertyName string, contentType string, body io.Reader) (*http.Request, error)

NewUpdatePropertyRequestWithBody generates requests for UpdateProperty 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 BatchCreatePropertiesJSONRequestBody 

type BatchCreatePropertiesJSONRequestBody = BatchPropertyInput

BatchCreatePropertiesJSONRequestBody defines body for BatchCreateProperties for application/json ContentType.

type BatchCreatePropertiesResponse 

type BatchCreatePropertiesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *BatchPropertyResponse
	JSON207      *BatchPropertyResponse
	JSON400      *N400Error
	JSON401      *N401Error
	JSON403      *N403Error
}

func ParseBatchCreatePropertiesResponse 

func ParseBatchCreatePropertiesResponse(rsp *http.Response) (*BatchCreatePropertiesResponse, error)

ParseBatchCreatePropertiesResponse parses an HTTP response from a BatchCreatePropertiesWithResponse call

func (BatchCreatePropertiesResponse) Status 

func (r BatchCreatePropertiesResponse) Status() string

Status returns HTTPResponse.Status

func (BatchCreatePropertiesResponse) StatusCode 

func (r BatchCreatePropertiesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type BatchError 

type BatchError struct {
	Code    *string                 `json:"code,omitempty"`
	Context *map[string]interface{} `json:"context,omitempty"`
	Message *string                 `json:"message,omitempty"`
}

BatchError defines model for BatchError.

type BatchPropertyInput 

type BatchPropertyInput struct {
	// Inputs Batch of properties to create
	Inputs []Property `json:"inputs"`
}

BatchPropertyInput defines model for BatchPropertyInput.

type BatchPropertyResponse 

type BatchPropertyResponse struct {
	Errors  *[]BatchError                `json:"errors,omitempty"`
	Results *[]Property                  `json:"results,omitempty"`
	Status  *BatchPropertyResponseStatus `json:"status,omitempty"`
}

BatchPropertyResponse defines model for BatchPropertyResponse.

type BatchPropertyResponseStatus 

type BatchPropertyResponseStatus string

BatchPropertyResponseStatus defines model for BatchPropertyResponse.Status. 

const (
	COMPLETE BatchPropertyResponseStatus = "COMPLETE"
	PENDING  BatchPropertyResponseStatus = "PENDING"
)

Defines values for BatchPropertyResponseStatus.

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) BatchCreateProperties 

func (c *Client) BatchCreateProperties(ctx context.Context, objectType ObjectType, body BatchCreatePropertiesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) BatchCreatePropertiesWithBody 

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

func (*Client) GetProperties 

func (c *Client) GetProperties(ctx context.Context, objectType ObjectType, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateProperty added in v0.0.14 

func (c *Client) UpdateProperty(ctx context.Context, objectType ObjectType, propertyName string, body UpdatePropertyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdatePropertyWithBody added in v0.0.14 

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

type ClientInterface 

type ClientInterface interface {
	// GetProperties request
	GetProperties(ctx context.Context, objectType ObjectType, reqEditors ...RequestEditorFn) (*http.Response, error)

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

	BatchCreateProperties(ctx context.Context, objectType ObjectType, body BatchCreatePropertiesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

	UpdateProperty(ctx context.Context, objectType ObjectType, propertyName string, body UpdatePropertyJSONRequestBody, 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) BatchCreatePropertiesWithBodyWithResponse 

func (c *ClientWithResponses) BatchCreatePropertiesWithBodyWithResponse(ctx context.Context, objectType ObjectType, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*BatchCreatePropertiesResponse, error)

BatchCreatePropertiesWithBodyWithResponse request with arbitrary body returning *BatchCreatePropertiesResponse

func (*ClientWithResponses) BatchCreatePropertiesWithResponse 

func (c *ClientWithResponses) BatchCreatePropertiesWithResponse(ctx context.Context, objectType ObjectType, body BatchCreatePropertiesJSONRequestBody, reqEditors ...RequestEditorFn) (*BatchCreatePropertiesResponse, error)

func (*ClientWithResponses) GetPropertiesWithResponse 

func (c *ClientWithResponses) GetPropertiesWithResponse(ctx context.Context, objectType ObjectType, reqEditors ...RequestEditorFn) (*GetPropertiesResponse, error)

GetPropertiesWithResponse request returning *GetPropertiesResponse

func (*ClientWithResponses) UpdatePropertyWithBodyWithResponse added in v0.0.14 

func (c *ClientWithResponses) UpdatePropertyWithBodyWithResponse(ctx context.Context, objectType ObjectType, propertyName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdatePropertyResponse, error)

UpdatePropertyWithBodyWithResponse request with arbitrary body returning *UpdatePropertyResponse

func (*ClientWithResponses) UpdatePropertyWithResponse added in v0.0.14 

func (c *ClientWithResponses) UpdatePropertyWithResponse(ctx context.Context, objectType ObjectType, propertyName string, body UpdatePropertyJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdatePropertyResponse, error)

type ClientWithResponsesInterface 

type ClientWithResponsesInterface interface {
	// GetPropertiesWithResponse request
	GetPropertiesWithResponse(ctx context.Context, objectType ObjectType, reqEditors ...RequestEditorFn) (*GetPropertiesResponse, error)

	// BatchCreatePropertiesWithBodyWithResponse request with any body
	BatchCreatePropertiesWithBodyWithResponse(ctx context.Context, objectType ObjectType, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*BatchCreatePropertiesResponse, error)

	BatchCreatePropertiesWithResponse(ctx context.Context, objectType ObjectType, body BatchCreatePropertiesJSONRequestBody, reqEditors ...RequestEditorFn) (*BatchCreatePropertiesResponse, error)

	// UpdatePropertyWithBodyWithResponse request with any body
	UpdatePropertyWithBodyWithResponse(ctx context.Context, objectType ObjectType, propertyName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdatePropertyResponse, error)

	UpdatePropertyWithResponse(ctx context.Context, objectType ObjectType, propertyName string, body UpdatePropertyJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdatePropertyResponse, error)
}

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

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 

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 

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

ErrorContext defines model for ErrorContext.

type ErrorDetail 

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 GetPropertiesResponse 

type GetPropertiesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PropertyCollectionResponse
	JSON400      *N400Error
	JSON401      *N401Error
}

func ParseGetPropertiesResponse 

func ParseGetPropertiesResponse(rsp *http.Response) (*GetPropertiesResponse, error)

ParseGetPropertiesResponse parses an HTTP response from a GetPropertiesWithResponse call

func (GetPropertiesResponse) Status 

func (r GetPropertiesResponse) Status() string

Status returns HTTPResponse.Status

func (GetPropertiesResponse) StatusCode 

func (r GetPropertiesResponse) 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 N400Error 

type N400Error = Error

N400Error defines model for 400Error.

type N401Error 

type N401Error = Error

N401Error defines model for 401Error.

type N403Error 

type N403Error = Error

N403Error defines model for 403Error.

type ObjectType 

type ObjectType string

ObjectType defines model for ObjectType. 

const (
	ObjectTypeCompanies ObjectType = "companies"
	ObjectTypeContacts  ObjectType = "contacts"
	ObjectTypeDeals     ObjectType = "deals"
	ObjectTypeOrders    ObjectType = "orders"
	ObjectTypeProducts  ObjectType = "products"
)

Defines values for ObjectType.

type Paging 

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

Paging defines model for Paging.

type PagingNext 

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

PagingNext defines model for PagingNext.

type Property 

type Property struct {
	// Archived Whether the property is archived
	Archived *bool `json:"archived,omitempty"`

	// CalculationFormula FHIRPath formula for calculated properties
	CalculationFormula *string `json:"calculationFormula,omitempty"`

	// Description A description of the property
	Description *string `json:"description,omitempty"`

	// DisplayOrder The order this property appears in the UI
	DisplayOrder *int `json:"displayOrder,omitempty"`

	// ExternalOptions Whether options are fetched externally
	ExternalOptions *bool `json:"externalOptions,omitempty"`

	// FieldType Controls how the property appears in forms
	FieldType PropertyFieldType `json:"fieldType"`

	// FormField Whether the property should be available in forms
	FormField *bool `json:"formField,omitempty"`

	// GroupName The internal name of the property group
	GroupName *string `json:"groupName,omitempty"`

	// HasUniqueValue Whether property values must be unique
	HasUniqueValue *bool `json:"hasUniqueValue,omitempty"`

	// Hidden Whether the property should be hidden from UI
	Hidden *bool `json:"hidden,omitempty"`

	// Label Display label
	Label string `json:"label"`

	// Name Internal property name (must be lowercase with underscores)
	Name    string            `json:"name"`
	Options *[]PropertyOption `json:"options,omitempty"`

	// ReferencedObjectType For reference properties, the referenced object type
	ReferencedObjectType *string `json:"referencedObjectType,omitempty"`

	// Type The data type of the property
	Type PropertyType `json:"type"`
}

Property defines model for Property.

type PropertyCollectionResponse 

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

PropertyCollectionResponse defines model for PropertyCollectionResponse.

type PropertyFieldType 

type PropertyFieldType string

PropertyFieldType Controls how the property appears in forms 

const (
	PropertyFieldTypeCheckbox PropertyFieldType = "checkbox"
	PropertyFieldTypeDate     PropertyFieldType = "date"
	PropertyFieldTypeDatetime PropertyFieldType = "datetime"
	PropertyFieldTypeFile     PropertyFieldType = "file"
	PropertyFieldTypeNumber   PropertyFieldType = "number"
	PropertyFieldTypeRadio    PropertyFieldType = "radio"
	PropertyFieldTypeSelect   PropertyFieldType = "select"
	PropertyFieldTypeText     PropertyFieldType = "text"
	PropertyFieldTypeTextarea PropertyFieldType = "textarea"
)

Defines values for PropertyFieldType.

type PropertyOption 

type PropertyOption struct {
	// Description A description of the option
	Description *string `json:"description,omitempty"`

	// DisplayOrder The order this option appears in dropdowns
	DisplayOrder *int `json:"displayOrder,omitempty"`

	// Hidden Whether the option should be hidden
	Hidden *bool `json:"hidden,omitempty"`

	// Label The user-facing label for the option
	Label string `json:"label"`

	// Value The internal value for the option
	Value string `json:"value"`
}

PropertyOption defines model for PropertyOption.

type PropertyType 

type PropertyType string

PropertyType The data type of the property 

const (
	PropertyTypeBool        PropertyType = "bool"
	PropertyTypeDatetime    PropertyType = "datetime"
	PropertyTypeEnumeration PropertyType = "enumeration"
	PropertyTypeNumber      PropertyType = "number"
	PropertyTypeString      PropertyType = "string"
)

Defines values for PropertyType.

type PropertyUpdateInput added in v0.0.14 

type PropertyUpdateInput struct {
	// Archived Whether the property is archived
	Archived *bool `json:"archived,omitempty"`

	// CalculationFormula FHIRPath formula for calculated properties
	CalculationFormula *string `json:"calculationFormula,omitempty"`

	// Description A description of the property
	Description *string `json:"description,omitempty"`

	// DisplayOrder The order this property appears in the UI
	DisplayOrder *int `json:"displayOrder,omitempty"`

	// ExternalOptions Whether options are fetched externally
	ExternalOptions *bool       `json:"externalOptions,omitempty"`
	FieldType       interface{} `json:"fieldType"`

	// FormField Whether the property should be available in forms
	FormField *bool `json:"formField,omitempty"`

	// GroupName The internal name of the property group
	GroupName *string `json:"groupName,omitempty"`

	// HasUniqueValue Whether property values must be unique
	HasUniqueValue *bool `json:"hasUniqueValue,omitempty"`

	// Hidden Whether the property should be hidden from UI
	Hidden *bool `json:"hidden,omitempty"`

	// Label Display label
	Label   string            `json:"label"`
	Name    interface{}       `json:"name"`
	Options *[]PropertyOption `json:"options,omitempty"`

	// ReferencedObjectType For reference properties, the referenced object type
	ReferencedObjectType *string     `json:"referencedObjectType,omitempty"`
	Type                 interface{} `json:"type"`
}

PropertyUpdateInput defines model for PropertyUpdateInput.

type RequestEditorFn 

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

RequestEditorFn is the function signature for the RequestEditor callback function

type ServerInterface 

type ServerInterface interface {
	// Get existing properties
	// (GET /crm/v3/properties/{objectType})
	GetProperties(ctx echo.Context, objectType ObjectType) error
	// Batch create properties
	// (POST /crm/v3/properties/{objectType}/batch/create)
	BatchCreateProperties(ctx echo.Context, objectType ObjectType) error
	// Update a property
	// (PATCH /crm/v3/properties/{objectType}/{propertyName})
	UpdateProperty(ctx echo.Context, objectType ObjectType, propertyName string) error
}

ServerInterface represents all server handlers.

type ServerInterfaceWrapper 

type ServerInterfaceWrapper struct {
	Handler ServerInterface
}

ServerInterfaceWrapper converts echo contexts to parameters.

func (*ServerInterfaceWrapper) BatchCreateProperties 

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

BatchCreateProperties converts echo context to params.

func (*ServerInterfaceWrapper) GetProperties 

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

GetProperties converts echo context to params.

func (*ServerInterfaceWrapper) UpdateProperty added in v0.0.14 

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

UpdateProperty converts echo context to params.

type UpdatePropertyJSONRequestBody added in v0.0.14 

type UpdatePropertyJSONRequestBody = PropertyUpdateInput

UpdatePropertyJSONRequestBody defines body for UpdateProperty for application/json ContentType.

type UpdatePropertyResponse added in v0.0.14 

type UpdatePropertyResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Property
	JSON400      *N400Error
	JSON401      *N401Error
	JSON403      *N403Error
}

func ParseUpdatePropertyResponse added in v0.0.14 

func ParseUpdatePropertyResponse(rsp *http.Response) (*UpdatePropertyResponse, error)

ParseUpdatePropertyResponse parses an HTTP response from a UpdatePropertyWithResponse call

func (UpdatePropertyResponse) Status added in v0.0.14 

func (r UpdatePropertyResponse) Status() string

Status returns HTTPResponse.Status

func (UpdatePropertyResponse) StatusCode added in v0.0.14 

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