Documentation
¶
Overview ¶
Package quotes provides primitives to interact with the openapi HTTP API.
Code generated by github.com/faetools/devtool version (devel) DO NOT EDIT.
Package quotes provides primitives to interact with the openapi HTTP API.
Code generated by github.com/faetools/devtool version (devel) DO NOT EDIT.
Index ¶
- Constants
- type AssociatedId
- type BatchReadInputSimplePublicObjectId
- type BatchResponseSimplePublicObject
- type BatchResponseSimplePublicObjectStatus
- type BatchResponseSimplePublicObjectWithErrors
- type BatchResponseSimplePublicObjectWithErrorsStatus
- type BatchResponseSimplePublicObjectWithErrors_Links
- func (a BatchResponseSimplePublicObjectWithErrors_Links) Get(fieldName string) (value string, found bool)
- func (a BatchResponseSimplePublicObjectWithErrors_Links) MarshalJSON() ([]byte, error)
- func (a *BatchResponseSimplePublicObjectWithErrors_Links) Set(fieldName string, value string)
- func (a *BatchResponseSimplePublicObjectWithErrors_Links) UnmarshalJSON(b []byte) error
- type BatchResponseSimplePublicObject_Links
- func (a BatchResponseSimplePublicObject_Links) Get(fieldName string) (value string, found bool)
- func (a BatchResponseSimplePublicObject_Links) MarshalJSON() ([]byte, error)
- func (a *BatchResponseSimplePublicObject_Links) Set(fieldName string, value string)
- func (a *BatchResponseSimplePublicObject_Links) UnmarshalJSON(b []byte) error
- type Client
- func (c *Client) DoSearch(ctx context.Context, body DoSearchJSONRequestBody, ...) (*DoSearchResponse, error)
- func (c *Client) DoSearchWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*DoSearchResponse, error)
- func (c *Client) GetAllToObjectType(ctx context.Context, quoteId string, toObjectType string, ...) (*GetAllToObjectTypeResponse, error)
- func (c *Client) GetQuote(ctx context.Context, quoteId string, params *GetQuoteParams, ...) (*GetQuoteResponse, error)
- func (c *Client) ListQuotes(ctx context.Context, params *ListQuotesParams, ...) (*ListQuotesResponse, error)
- func (c *Client) ReadBatch(ctx context.Context, params *ReadBatchParams, body ReadBatchJSONRequestBody, ...) (*ReadBatchResponse, error)
- func (c *Client) ReadBatchWithBody(ctx context.Context, params *ReadBatchParams, contentType string, ...) (*ReadBatchResponse, error)
- type ClientInterface
- type CollectionResponseAssociatedId
- type CollectionResponseAssociatedIdForwardPaging
- type CollectionResponseSimplePublicObjectWithAssociationsForwardPaging
- type CollectionResponseWithTotalSimplePublicObjectForwardPaging
- type DoSearchJSONBody
- type DoSearchJSONRequestBody
- type DoSearchResponse
- type Error
- type ErrorCategory
- type ErrorCategoryHttpStatus
- type ErrorDetail
- type ErrorDetail_Context
- type Error_Context
- type Error_Links
- type Filter
- type FilterGroup
- type FilterOperator
- type ForwardPaging
- type GetAllToObjectTypeParams
- type GetAllToObjectTypeResponse
- type GetQuoteParams
- type GetQuoteResponse
- type ListQuotesParams
- type ListQuotesResponse
- type NextPage
- type Paging
- type PreviousPage
- type PublicObjectSearchRequest
- type ReadBatchJSONBody
- type ReadBatchJSONRequestBody
- type ReadBatchParams
- type ReadBatchResponse
- type SimplePublicObject
- type SimplePublicObjectId
- type SimplePublicObjectWithAssociations
- type SimplePublicObjectWithAssociations_Associations
- func (a SimplePublicObjectWithAssociations_Associations) Get(fieldName string) (value CollectionResponseAssociatedId, found bool)
- func (a SimplePublicObjectWithAssociations_Associations) MarshalJSON() ([]byte, error)
- func (a *SimplePublicObjectWithAssociations_Associations) Set(fieldName string, value CollectionResponseAssociatedId)
- func (a *SimplePublicObjectWithAssociations_Associations) UnmarshalJSON(b []byte) error
- type SimplePublicObjectWithAssociations_Properties
- func (a SimplePublicObjectWithAssociations_Properties) Get(fieldName string) (value string, found bool)
- func (a SimplePublicObjectWithAssociations_Properties) MarshalJSON() ([]byte, error)
- func (a *SimplePublicObjectWithAssociations_Properties) Set(fieldName string, value string)
- func (a *SimplePublicObjectWithAssociations_Properties) UnmarshalJSON(b []byte) error
- type SimplePublicObject_Properties
- func (a SimplePublicObject_Properties) Get(fieldName string) (value string, found bool)
- func (a SimplePublicObject_Properties) MarshalJSON() ([]byte, error)
- func (a *SimplePublicObject_Properties) Set(fieldName string, value string)
- func (a *SimplePublicObject_Properties) UnmarshalJSON(b []byte) error
- type StandardError
- type StandardError_Context
- type StandardError_Links
Constants ¶
const DefaultServer = "https://api.hubapi.com/"
DefaultServer is the default server to be used.
const (
HapikeyScopes = "hapikey.Scopes"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AssociatedId ¶
AssociatedId defines model for AssociatedId.
type BatchReadInputSimplePublicObjectId ¶
type BatchReadInputSimplePublicObjectId struct {
IdProperty *string `json:"idProperty,omitempty"`
Inputs []SimplePublicObjectId `json:"inputs"`
Properties []string `json:"properties"`
}
BatchReadInputSimplePublicObjectId defines model for BatchReadInputSimplePublicObjectId.
type BatchResponseSimplePublicObject ¶
type BatchResponseSimplePublicObject struct {
CompletedAt time.Time `json:"completedAt"`
Links *BatchResponseSimplePublicObject_Links `json:"links,omitempty"`
RequestedAt *time.Time `json:"requestedAt,omitempty"`
Results []SimplePublicObject `json:"results"`
StartedAt time.Time `json:"startedAt"`
Status BatchResponseSimplePublicObjectStatus `json:"status"`
}
BatchResponseSimplePublicObject defines model for BatchResponseSimplePublicObject.
type BatchResponseSimplePublicObjectStatus ¶
type BatchResponseSimplePublicObjectStatus string
BatchResponseSimplePublicObjectStatus defines model for BatchResponseSimplePublicObject.Status.
const ( BatchResponseSimplePublicObjectStatusCANCELED BatchResponseSimplePublicObjectStatus = "CANCELED" BatchResponseSimplePublicObjectStatusCOMPLETE BatchResponseSimplePublicObjectStatus = "COMPLETE" BatchResponseSimplePublicObjectStatusPENDING BatchResponseSimplePublicObjectStatus = "PENDING" BatchResponseSimplePublicObjectStatusPROCESSING BatchResponseSimplePublicObjectStatus = "PROCESSING" )
Defines values for BatchResponseSimplePublicObjectStatus.
type BatchResponseSimplePublicObjectWithErrors ¶
type BatchResponseSimplePublicObjectWithErrors struct {
CompletedAt time.Time `json:"completedAt"`
Errors *[]StandardError `json:"errors,omitempty"`
Links *BatchResponseSimplePublicObjectWithErrors_Links `json:"links,omitempty"`
NumErrors *int32 `json:"numErrors,omitempty"`
RequestedAt *time.Time `json:"requestedAt,omitempty"`
Results []SimplePublicObject `json:"results"`
StartedAt time.Time `json:"startedAt"`
Status BatchResponseSimplePublicObjectWithErrorsStatus `json:"status"`
}
BatchResponseSimplePublicObjectWithErrors defines model for BatchResponseSimplePublicObjectWithErrors.
type BatchResponseSimplePublicObjectWithErrorsStatus ¶
type BatchResponseSimplePublicObjectWithErrorsStatus string
BatchResponseSimplePublicObjectWithErrorsStatus defines model for BatchResponseSimplePublicObjectWithErrors.Status.
const ( BatchResponseSimplePublicObjectWithErrorsStatusCANCELED BatchResponseSimplePublicObjectWithErrorsStatus = "CANCELED" BatchResponseSimplePublicObjectWithErrorsStatusCOMPLETE BatchResponseSimplePublicObjectWithErrorsStatus = "COMPLETE" BatchResponseSimplePublicObjectWithErrorsStatusPENDING BatchResponseSimplePublicObjectWithErrorsStatus = "PENDING" BatchResponseSimplePublicObjectWithErrorsStatusPROCESSING BatchResponseSimplePublicObjectWithErrorsStatus = "PROCESSING" )
Defines values for BatchResponseSimplePublicObjectWithErrorsStatus.
type BatchResponseSimplePublicObjectWithErrors_Links ¶
type BatchResponseSimplePublicObjectWithErrors_Links struct {
AdditionalProperties map[string]string `json:"-"`
}
BatchResponseSimplePublicObjectWithErrors_Links defines model for BatchResponseSimplePublicObjectWithErrors.Links.
func (BatchResponseSimplePublicObjectWithErrors_Links) Get ¶
func (a BatchResponseSimplePublicObjectWithErrors_Links) Get(fieldName string) (value string, found bool)
Getter for additional properties for BatchResponseSimplePublicObjectWithErrors_Links. Returns the specified element and whether it was found
func (BatchResponseSimplePublicObjectWithErrors_Links) MarshalJSON ¶
func (a BatchResponseSimplePublicObjectWithErrors_Links) MarshalJSON() ([]byte, error)
Override default JSON handling for BatchResponseSimplePublicObjectWithErrors_Links to handle AdditionalProperties
func (*BatchResponseSimplePublicObjectWithErrors_Links) Set ¶
func (a *BatchResponseSimplePublicObjectWithErrors_Links) Set(fieldName string, value string)
Setter for additional properties for BatchResponseSimplePublicObjectWithErrors_Links
func (*BatchResponseSimplePublicObjectWithErrors_Links) UnmarshalJSON ¶
func (a *BatchResponseSimplePublicObjectWithErrors_Links) UnmarshalJSON(b []byte) error
Override default JSON handling for BatchResponseSimplePublicObjectWithErrors_Links to handle AdditionalProperties
type BatchResponseSimplePublicObject_Links ¶
type BatchResponseSimplePublicObject_Links struct {
AdditionalProperties map[string]string `json:"-"`
}
BatchResponseSimplePublicObject_Links defines model for BatchResponseSimplePublicObject.Links.
func (BatchResponseSimplePublicObject_Links) Get ¶
func (a BatchResponseSimplePublicObject_Links) Get(fieldName string) (value string, found bool)
Getter for additional properties for BatchResponseSimplePublicObject_Links. Returns the specified element and whether it was found
func (BatchResponseSimplePublicObject_Links) MarshalJSON ¶
func (a BatchResponseSimplePublicObject_Links) MarshalJSON() ([]byte, error)
Override default JSON handling for BatchResponseSimplePublicObject_Links to handle AdditionalProperties
func (*BatchResponseSimplePublicObject_Links) Set ¶
func (a *BatchResponseSimplePublicObject_Links) Set(fieldName string, value string)
Setter for additional properties for BatchResponseSimplePublicObject_Links
func (*BatchResponseSimplePublicObject_Links) UnmarshalJSON ¶
func (a *BatchResponseSimplePublicObject_Links) UnmarshalJSON(b []byte) error
Override default JSON handling for BatchResponseSimplePublicObject_Links to handle AdditionalProperties
type Client ¶
Client conforms to the OpenAPI3 specification for this service.
func NewClient ¶
NewClient creates a new Client with reasonable defaults.
func (*Client) DoSearch ¶
func (c *Client) DoSearch(ctx context.Context, body DoSearchJSONRequestBody, reqEditors ...client.RequestEditorFn) (*DoSearchResponse, error)
func (*Client) DoSearchWithBody ¶
func (c *Client) DoSearchWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*DoSearchResponse, error)
DoSearchWithBody request with arbitrary body returning *DoSearchResponse
func (*Client) GetAllToObjectType ¶
func (c *Client) GetAllToObjectType(ctx context.Context, quoteId string, toObjectType string, params *GetAllToObjectTypeParams, reqEditors ...client.RequestEditorFn) (*GetAllToObjectTypeResponse, error)
GetAllToObjectType request returning *GetAllToObjectTypeResponse
func (*Client) GetQuote ¶
func (c *Client) GetQuote(ctx context.Context, quoteId string, params *GetQuoteParams, reqEditors ...client.RequestEditorFn) (*GetQuoteResponse, error)
GetQuote request returning *GetQuoteResponse
func (*Client) ListQuotes ¶
func (c *Client) ListQuotes(ctx context.Context, params *ListQuotesParams, reqEditors ...client.RequestEditorFn) (*ListQuotesResponse, error)
ListQuotes request returning *ListQuotesResponse
func (*Client) ReadBatch ¶
func (c *Client) ReadBatch(ctx context.Context, params *ReadBatchParams, body ReadBatchJSONRequestBody, reqEditors ...client.RequestEditorFn) (*ReadBatchResponse, error)
func (*Client) ReadBatchWithBody ¶
func (c *Client) ReadBatchWithBody(ctx context.Context, params *ReadBatchParams, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*ReadBatchResponse, error)
ReadBatchWithBody request with arbitrary body returning *ReadBatchResponse
type ClientInterface ¶
type ClientInterface interface {
// ListQuotes request
ListQuotes(ctx context.Context, params *ListQuotesParams, reqEditors ...client.RequestEditorFn) (*ListQuotesResponse, error)
// ReadBatch request with any body
ReadBatchWithBody(ctx context.Context, params *ReadBatchParams, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*ReadBatchResponse, error)
ReadBatch(ctx context.Context, params *ReadBatchParams, body ReadBatchJSONRequestBody, reqEditors ...client.RequestEditorFn) (*ReadBatchResponse, error)
// DoSearch request with any body
DoSearchWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*DoSearchResponse, error)
DoSearch(ctx context.Context, body DoSearchJSONRequestBody, reqEditors ...client.RequestEditorFn) (*DoSearchResponse, error)
// GetQuote request
GetQuote(ctx context.Context, quoteId string, params *GetQuoteParams, reqEditors ...client.RequestEditorFn) (*GetQuoteResponse, error)
// GetAllToObjectType request
GetAllToObjectType(ctx context.Context, quoteId string, toObjectType string, params *GetAllToObjectTypeParams, reqEditors ...client.RequestEditorFn) (*GetAllToObjectTypeResponse, error)
}
ClientInterface interface specification for the client.
type CollectionResponseAssociatedId ¶
type CollectionResponseAssociatedId struct {
Paging *Paging `json:"paging,omitempty"`
Results []AssociatedId `json:"results"`
}
CollectionResponseAssociatedId defines model for CollectionResponseAssociatedId.
type CollectionResponseAssociatedIdForwardPaging ¶
type CollectionResponseAssociatedIdForwardPaging struct {
Paging *ForwardPaging `json:"paging,omitempty"`
Results []AssociatedId `json:"results"`
}
CollectionResponseAssociatedIdForwardPaging defines model for CollectionResponseAssociatedIdForwardPaging.
type CollectionResponseSimplePublicObjectWithAssociationsForwardPaging ¶
type CollectionResponseSimplePublicObjectWithAssociationsForwardPaging struct {
Paging *ForwardPaging `json:"paging,omitempty"`
Results []SimplePublicObjectWithAssociations `json:"results"`
}
CollectionResponseSimplePublicObjectWithAssociationsForwardPaging defines model for CollectionResponseSimplePublicObjectWithAssociationsForwardPaging.
type CollectionResponseWithTotalSimplePublicObjectForwardPaging ¶
type CollectionResponseWithTotalSimplePublicObjectForwardPaging struct {
Paging *ForwardPaging `json:"paging,omitempty"`
Results []SimplePublicObject `json:"results"`
Total int32 `json:"total"`
}
CollectionResponseWithTotalSimplePublicObjectForwardPaging defines model for CollectionResponseWithTotalSimplePublicObjectForwardPaging.
type DoSearchJSONBody ¶
type DoSearchJSONBody PublicObjectSearchRequest
DoSearchJSONBody defines parameters for DoSearch.
type DoSearchJSONRequestBody ¶
type DoSearchJSONRequestBody DoSearchJSONBody
DoSearchJSONRequestBody defines body for DoSearch for application/json ContentType.
type DoSearchResponse ¶
type DoSearchResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *CollectionResponseWithTotalSimplePublicObjectForwardPaging
}
func (DoSearchResponse) Status ¶
func (r DoSearchResponse) Status() string
Status returns HTTPResponse.Status
func (DoSearchResponse) StatusCode ¶
func (r DoSearchResponse) 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 ErrorCategory ¶
type ErrorCategory struct {
HttpStatus ErrorCategoryHttpStatus `json:"httpStatus"`
Name string `json:"name"`
}
ErrorCategory defines model for ErrorCategory.
type ErrorCategoryHttpStatus ¶
type ErrorCategoryHttpStatus string
ErrorCategoryHttpStatus defines model for ErrorCategory.HttpStatus.
const ( ErrorCategoryHttpStatusACCEPTED ErrorCategoryHttpStatus = "ACCEPTED" ErrorCategoryHttpStatusALREADYREPORTED ErrorCategoryHttpStatus = "ALREADY_REPORTED" ErrorCategoryHttpStatusBADGATEWAY ErrorCategoryHttpStatus = "BAD_GATEWAY" ErrorCategoryHttpStatusBADREQUEST ErrorCategoryHttpStatus = "BAD_REQUEST" ErrorCategoryHttpStatusCONFLICT ErrorCategoryHttpStatus = "CONFLICT" ErrorCategoryHttpStatusCONTINUE ErrorCategoryHttpStatus = "CONTINUE" ErrorCategoryHttpStatusCREATED ErrorCategoryHttpStatus = "CREATED" ErrorCategoryHttpStatusEXPECTATIONFAILED ErrorCategoryHttpStatus = "EXPECTATION_FAILED" ErrorCategoryHttpStatusFAILEDDEPENDENCY ErrorCategoryHttpStatus = "FAILED_DEPENDENCY" ErrorCategoryHttpStatusFORBIDDEN ErrorCategoryHttpStatus = "FORBIDDEN" ErrorCategoryHttpStatusFOUND ErrorCategoryHttpStatus = "FOUND" ErrorCategoryHttpStatusGATEWAYTIMEOUT ErrorCategoryHttpStatus = "GATEWAY_TIMEOUT" ErrorCategoryHttpStatusGONE ErrorCategoryHttpStatus = "GONE" ErrorCategoryHttpStatusHTTPVERSIONNOTSUPPORTED ErrorCategoryHttpStatus = "HTTP_VERSION_NOT_SUPPORTED" ErrorCategoryHttpStatusIMATEAPOT ErrorCategoryHttpStatus = "IM_A_TEAPOT" ErrorCategoryHttpStatusIMUSED ErrorCategoryHttpStatus = "IM_USED" ErrorCategoryHttpStatusINSUFFICIENTSTORAGE ErrorCategoryHttpStatus = "INSUFFICIENT_STORAGE" ErrorCategoryHttpStatusINTERNALSERVERERROR ErrorCategoryHttpStatus = "INTERNAL_SERVER_ERROR" ErrorCategoryHttpStatusINTERNALSTALESERVICEDISCOVERY ErrorCategoryHttpStatus = "INTERNAL_STALE_SERVICE_DISCOVERY" ErrorCategoryHttpStatusLENGTHREQUIRED ErrorCategoryHttpStatus = "LENGTH_REQUIRED" ErrorCategoryHttpStatusLOCKED ErrorCategoryHttpStatus = "LOCKED" ErrorCategoryHttpStatusLOOPDETECTED ErrorCategoryHttpStatus = "LOOP_DETECTED" ErrorCategoryHttpStatusMETHODNOTALLOWED ErrorCategoryHttpStatus = "METHOD_NOT_ALLOWED" ErrorCategoryHttpStatusMISDIRECTEDREQUEST ErrorCategoryHttpStatus = "MISDIRECTED_REQUEST" ErrorCategoryHttpStatusMOVEDPERMANENTLY ErrorCategoryHttpStatus = "MOVED_PERMANENTLY" ErrorCategoryHttpStatusMULTIPLECHOICES ErrorCategoryHttpStatus = "MULTIPLE_CHOICES" ErrorCategoryHttpStatusMULTISTATUS ErrorCategoryHttpStatus = "MULTI_STATUS" ErrorCategoryHttpStatusNETWORKAUTHENTICATIONREQUIRED ErrorCategoryHttpStatus = "NETWORK_AUTHENTICATION_REQUIRED" ErrorCategoryHttpStatusNOCONTENT ErrorCategoryHttpStatus = "NO_CONTENT" ErrorCategoryHttpStatusNONAUTHORITATIVEINFORMATION ErrorCategoryHttpStatus = "NON_AUTHORITATIVE_INFORMATION" ErrorCategoryHttpStatusNOTACCEPTABLE ErrorCategoryHttpStatus = "NOT_ACCEPTABLE" ErrorCategoryHttpStatusNOTEXTENDED ErrorCategoryHttpStatus = "NOT_EXTENDED" ErrorCategoryHttpStatusNOTFOUND ErrorCategoryHttpStatus = "NOT_FOUND" ErrorCategoryHttpStatusNOTIMPLEMENTED ErrorCategoryHttpStatus = "NOT_IMPLEMENTED" ErrorCategoryHttpStatusNOTMODIFIED ErrorCategoryHttpStatus = "NOT_MODIFIED" ErrorCategoryHttpStatusOK ErrorCategoryHttpStatus = "OK" ErrorCategoryHttpStatusPARTIALCONTENT ErrorCategoryHttpStatus = "PARTIAL_CONTENT" ErrorCategoryHttpStatusPAYMENTREQUIRED ErrorCategoryHttpStatus = "PAYMENT_REQUIRED" ErrorCategoryHttpStatusPERMANENTREDIRECT ErrorCategoryHttpStatus = "PERMANENT_REDIRECT" ErrorCategoryHttpStatusPRECONDITIONFAILED ErrorCategoryHttpStatus = "PRECONDITION_FAILED" ErrorCategoryHttpStatusPRECONDITIONREQUIRED ErrorCategoryHttpStatus = "PRECONDITION_REQUIRED" ErrorCategoryHttpStatusPROCESSING ErrorCategoryHttpStatus = "PROCESSING" ErrorCategoryHttpStatusPROXYAUTHENTICATIONREQUIRED ErrorCategoryHttpStatus = "PROXY_AUTHENTICATION_REQUIRED" ErrorCategoryHttpStatusREQUESTEDRANGENOTSATISFIABLE ErrorCategoryHttpStatus = "REQUESTED_RANGE_NOT_SATISFIABLE" ErrorCategoryHttpStatusREQUESTENTITYTOOLARGE ErrorCategoryHttpStatus = "REQUEST_ENTITY_TOO_LARGE" ErrorCategoryHttpStatusREQUESTHEADERSFIELDSTOOLARGE ErrorCategoryHttpStatus = "REQUEST_HEADERS_FIELDS_TOO_LARGE" ErrorCategoryHttpStatusREQUESTTIMEOUT ErrorCategoryHttpStatus = "REQUEST_TIMEOUT" ErrorCategoryHttpStatusREQUESTURITOOLONG ErrorCategoryHttpStatus = "REQUEST_URI_TOO_LONG" ErrorCategoryHttpStatusRESETCONTENT ErrorCategoryHttpStatus = "RESET_CONTENT" ErrorCategoryHttpStatusSEEOTHER ErrorCategoryHttpStatus = "SEE_OTHER" ErrorCategoryHttpStatusSERVICEUNAVAILABLE ErrorCategoryHttpStatus = "SERVICE_UNAVAILABLE" ErrorCategoryHttpStatusSWITCHINGPROTOCOLS ErrorCategoryHttpStatus = "SWITCHING_PROTOCOLS" ErrorCategoryHttpStatusTEMPORARYREDIRECT ErrorCategoryHttpStatus = "TEMPORARY_REDIRECT" ErrorCategoryHttpStatusTOOMANYREQUESTS ErrorCategoryHttpStatus = "TOO_MANY_REQUESTS" ErrorCategoryHttpStatusUNAUTHORIZED ErrorCategoryHttpStatus = "UNAUTHORIZED" ErrorCategoryHttpStatusUNAVAILABLEFORLEGALREASONS ErrorCategoryHttpStatus = "UNAVAILABLE_FOR_LEGAL_REASONS" ErrorCategoryHttpStatusUNPROCESSABLEENTITY ErrorCategoryHttpStatus = "UNPROCESSABLE_ENTITY" ErrorCategoryHttpStatusUNSUPPORTEDMEDIATYPE ErrorCategoryHttpStatus = "UNSUPPORTED_MEDIA_TYPE" ErrorCategoryHttpStatusUPGRADEREQUIRED ErrorCategoryHttpStatus = "UPGRADE_REQUIRED" ErrorCategoryHttpStatusUSEPROXY ErrorCategoryHttpStatus = "USE_PROXY" ErrorCategoryHttpStatusVARIANTALSONEGOTIATES ErrorCategoryHttpStatus = "VARIANT_ALSO_NEGOTIATES" )
Defines values for ErrorCategoryHttpStatus.
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 ¶
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 ¶
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 ¶
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 Filter ¶
type Filter struct {
// null
Operator FilterOperator `json:"operator"`
PropertyName string `json:"propertyName"`
Value *string `json:"value,omitempty"`
}
Filter defines model for Filter.
type FilterGroup ¶
type FilterGroup struct {
Filters []Filter `json:"filters"`
}
FilterGroup defines model for FilterGroup.
type FilterOperator ¶
type FilterOperator string
null
const ( FilterOperatorBETWEEN FilterOperator = "BETWEEN" FilterOperatorCONTAINSTOKEN FilterOperator = "CONTAINS_TOKEN" FilterOperatorEQ FilterOperator = "EQ" FilterOperatorGT FilterOperator = "GT" FilterOperatorGTE FilterOperator = "GTE" FilterOperatorHASPROPERTY FilterOperator = "HAS_PROPERTY" FilterOperatorIN FilterOperator = "IN" FilterOperatorLT FilterOperator = "LT" FilterOperatorLTE FilterOperator = "LTE" FilterOperatorNEQ FilterOperator = "NEQ" FilterOperatorNOTCONTAINSTOKEN FilterOperator = "NOT_CONTAINS_TOKEN" FilterOperatorNOTHASPROPERTY FilterOperator = "NOT_HAS_PROPERTY" FilterOperatorNOTIN FilterOperator = "NOT_IN" )
Defines values for FilterOperator.
type ForwardPaging ¶
type ForwardPaging struct {
Next *NextPage `json:"next,omitempty"`
}
ForwardPaging defines model for ForwardPaging.
type GetAllToObjectTypeParams ¶
type GetAllToObjectTypeParams struct {
// The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
After *string `json:"after,omitempty"`
// The maximum number of results to display per page.
Limit *int32 `json:"limit,omitempty"`
}
GetAllToObjectTypeParams defines parameters for GetAllToObjectType.
type GetAllToObjectTypeResponse ¶
type GetAllToObjectTypeResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *CollectionResponseAssociatedIdForwardPaging
}
func (GetAllToObjectTypeResponse) Status ¶
func (r GetAllToObjectTypeResponse) Status() string
Status returns HTTPResponse.Status
func (GetAllToObjectTypeResponse) StatusCode ¶
func (r GetAllToObjectTypeResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetQuoteParams ¶
type GetQuoteParams struct {
// A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
Properties *[]string `json:"properties,omitempty"`
// A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
Associations *[]string `json:"associations,omitempty"`
// Whether to return only results that have been archived.
Archived *bool `json:"archived,omitempty"`
// The name of a property whose values are unique for this object type
IdProperty *string `json:"idProperty,omitempty"`
}
GetQuoteParams defines parameters for GetQuote.
type GetQuoteResponse ¶
type GetQuoteResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *SimplePublicObjectWithAssociations
}
func (GetQuoteResponse) Status ¶
func (r GetQuoteResponse) Status() string
Status returns HTTPResponse.Status
func (GetQuoteResponse) StatusCode ¶
func (r GetQuoteResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ListQuotesParams ¶
type ListQuotesParams struct {
// The maximum number of results to display per page.
Limit *int32 `json:"limit,omitempty"`
// The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
After *string `json:"after,omitempty"`
// A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
Properties *[]string `json:"properties,omitempty"`
// A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
Associations *[]string `json:"associations,omitempty"`
// Whether to return only results that have been archived.
Archived *bool `json:"archived,omitempty"`
}
ListQuotesParams defines parameters for ListQuotes.
type ListQuotesResponse ¶
type ListQuotesResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *CollectionResponseSimplePublicObjectWithAssociationsForwardPaging
}
func (ListQuotesResponse) Status ¶
func (r ListQuotesResponse) Status() string
Status returns HTTPResponse.Status
func (ListQuotesResponse) StatusCode ¶
func (r ListQuotesResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type NextPage ¶
NextPage defines model for NextPage.
type Paging ¶
type Paging struct {
Next *NextPage `json:"next,omitempty"`
Prev *PreviousPage `json:"prev,omitempty"`
}
Paging defines model for Paging.
type PreviousPage ¶
PreviousPage defines model for PreviousPage.
type PublicObjectSearchRequest ¶
type PublicObjectSearchRequest struct {
After int32 `json:"after"`
FilterGroups []FilterGroup `json:"filterGroups"`
Limit int32 `json:"limit"`
Properties []string `json:"properties"`
Query *string `json:"query,omitempty"`
Sorts []string `json:"sorts"`
}
PublicObjectSearchRequest defines model for PublicObjectSearchRequest.
type ReadBatchJSONBody ¶
type ReadBatchJSONBody BatchReadInputSimplePublicObjectId
ReadBatchJSONBody defines parameters for ReadBatch.
type ReadBatchJSONRequestBody ¶
type ReadBatchJSONRequestBody ReadBatchJSONBody
ReadBatchJSONRequestBody defines body for ReadBatch for application/json ContentType.
type ReadBatchParams ¶
type ReadBatchParams struct {
// Whether to return only results that have been archived.
Archived *bool `json:"archived,omitempty"`
}
ReadBatchParams defines parameters for ReadBatch.
type ReadBatchResponse ¶
type ReadBatchResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *BatchResponseSimplePublicObject
JSON207 *BatchResponseSimplePublicObjectWithErrors
}
func (ReadBatchResponse) Status ¶
func (r ReadBatchResponse) Status() string
Status returns HTTPResponse.Status
func (ReadBatchResponse) StatusCode ¶
func (r ReadBatchResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type SimplePublicObject ¶
type SimplePublicObject struct {
Archived *bool `json:"archived,omitempty"`
ArchivedAt *time.Time `json:"archivedAt,omitempty"`
CreatedAt time.Time `json:"createdAt"`
Id string `json:"id"`
Properties SimplePublicObject_Properties `json:"properties"`
UpdatedAt time.Time `json:"updatedAt"`
}
SimplePublicObject defines model for SimplePublicObject.
type SimplePublicObjectId ¶
type SimplePublicObjectId struct {
Id string `json:"id"`
}
SimplePublicObjectId defines model for SimplePublicObjectId.
type SimplePublicObjectWithAssociations ¶
type SimplePublicObjectWithAssociations struct {
Archived *bool `json:"archived,omitempty"`
ArchivedAt *time.Time `json:"archivedAt,omitempty"`
Associations *SimplePublicObjectWithAssociations_Associations `json:"associations,omitempty"`
CreatedAt time.Time `json:"createdAt"`
Id string `json:"id"`
Properties SimplePublicObjectWithAssociations_Properties `json:"properties"`
UpdatedAt time.Time `json:"updatedAt"`
}
SimplePublicObjectWithAssociations defines model for SimplePublicObjectWithAssociations.
type SimplePublicObjectWithAssociations_Associations ¶
type SimplePublicObjectWithAssociations_Associations struct {
AdditionalProperties map[string]CollectionResponseAssociatedId `json:"-"`
}
SimplePublicObjectWithAssociations_Associations defines model for SimplePublicObjectWithAssociations.Associations.
func (SimplePublicObjectWithAssociations_Associations) Get ¶
func (a SimplePublicObjectWithAssociations_Associations) Get(fieldName string) (value CollectionResponseAssociatedId, found bool)
Getter for additional properties for SimplePublicObjectWithAssociations_Associations. Returns the specified element and whether it was found
func (SimplePublicObjectWithAssociations_Associations) MarshalJSON ¶
func (a SimplePublicObjectWithAssociations_Associations) MarshalJSON() ([]byte, error)
Override default JSON handling for SimplePublicObjectWithAssociations_Associations to handle AdditionalProperties
func (*SimplePublicObjectWithAssociations_Associations) Set ¶
func (a *SimplePublicObjectWithAssociations_Associations) Set(fieldName string, value CollectionResponseAssociatedId)
Setter for additional properties for SimplePublicObjectWithAssociations_Associations
func (*SimplePublicObjectWithAssociations_Associations) UnmarshalJSON ¶
func (a *SimplePublicObjectWithAssociations_Associations) UnmarshalJSON(b []byte) error
Override default JSON handling for SimplePublicObjectWithAssociations_Associations to handle AdditionalProperties
type SimplePublicObjectWithAssociations_Properties ¶
type SimplePublicObjectWithAssociations_Properties struct {
AdditionalProperties map[string]string `json:"-"`
}
SimplePublicObjectWithAssociations_Properties defines model for SimplePublicObjectWithAssociations.Properties.
func (SimplePublicObjectWithAssociations_Properties) Get ¶
func (a SimplePublicObjectWithAssociations_Properties) Get(fieldName string) (value string, found bool)
Getter for additional properties for SimplePublicObjectWithAssociations_Properties. Returns the specified element and whether it was found
func (SimplePublicObjectWithAssociations_Properties) MarshalJSON ¶
func (a SimplePublicObjectWithAssociations_Properties) MarshalJSON() ([]byte, error)
Override default JSON handling for SimplePublicObjectWithAssociations_Properties to handle AdditionalProperties
func (*SimplePublicObjectWithAssociations_Properties) Set ¶
func (a *SimplePublicObjectWithAssociations_Properties) Set(fieldName string, value string)
Setter for additional properties for SimplePublicObjectWithAssociations_Properties
func (*SimplePublicObjectWithAssociations_Properties) UnmarshalJSON ¶
func (a *SimplePublicObjectWithAssociations_Properties) UnmarshalJSON(b []byte) error
Override default JSON handling for SimplePublicObjectWithAssociations_Properties to handle AdditionalProperties
type SimplePublicObject_Properties ¶
SimplePublicObject_Properties defines model for SimplePublicObject.Properties.
func (SimplePublicObject_Properties) Get ¶
func (a SimplePublicObject_Properties) Get(fieldName string) (value string, found bool)
Getter for additional properties for SimplePublicObject_Properties. Returns the specified element and whether it was found
func (SimplePublicObject_Properties) MarshalJSON ¶
func (a SimplePublicObject_Properties) MarshalJSON() ([]byte, error)
Override default JSON handling for SimplePublicObject_Properties to handle AdditionalProperties
func (*SimplePublicObject_Properties) Set ¶
func (a *SimplePublicObject_Properties) Set(fieldName string, value string)
Setter for additional properties for SimplePublicObject_Properties
func (*SimplePublicObject_Properties) UnmarshalJSON ¶
func (a *SimplePublicObject_Properties) UnmarshalJSON(b []byte) error
Override default JSON handling for SimplePublicObject_Properties to handle AdditionalProperties
type StandardError ¶
type StandardError struct {
Category ErrorCategory `json:"category"`
Context StandardError_Context `json:"context"`
Errors []ErrorDetail `json:"errors"`
Id *string `json:"id,omitempty"`
Links StandardError_Links `json:"links"`
Message string `json:"message"`
Status string `json:"status"`
SubCategory *map[string]interface{} `json:"subCategory,omitempty"`
}
StandardError defines model for StandardError.
type StandardError_Context ¶
StandardError_Context defines model for StandardError.Context.
func (StandardError_Context) Get ¶
func (a StandardError_Context) Get(fieldName string) (value []string, found bool)
Getter for additional properties for StandardError_Context. Returns the specified element and whether it was found
func (StandardError_Context) MarshalJSON ¶
func (a StandardError_Context) MarshalJSON() ([]byte, error)
Override default JSON handling for StandardError_Context to handle AdditionalProperties
func (*StandardError_Context) Set ¶
func (a *StandardError_Context) Set(fieldName string, value []string)
Setter for additional properties for StandardError_Context
func (*StandardError_Context) UnmarshalJSON ¶
func (a *StandardError_Context) UnmarshalJSON(b []byte) error
Override default JSON handling for StandardError_Context to handle AdditionalProperties
type StandardError_Links ¶
StandardError_Links defines model for StandardError.Links.
func (StandardError_Links) Get ¶
func (a StandardError_Links) Get(fieldName string) (value string, found bool)
Getter for additional properties for StandardError_Links. Returns the specified element and whether it was found
func (StandardError_Links) MarshalJSON ¶
func (a StandardError_Links) MarshalJSON() ([]byte, error)
Override default JSON handling for StandardError_Links to handle AdditionalProperties
func (*StandardError_Links) Set ¶
func (a *StandardError_Links) Set(fieldName string, value string)
Setter for additional properties for StandardError_Links
func (*StandardError_Links) UnmarshalJSON ¶
func (a *StandardError_Links) UnmarshalJSON(b []byte) error
Override default JSON handling for StandardError_Links to handle AdditionalProperties
Source Files
¶
- client.gen.go
- servers.gen.go
- types.gen.go