crmextensions

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

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

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

Documentation

Overview

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

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

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

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

Index

Constants

View Source
const DefaultServer = "https://api.hubapi.com/"

DefaultServer is the default server to be used.

View Source
const (
	Developer_hapikeyScopes = "developer_hapikey.Scopes"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type ActionConfirmationBody

type ActionConfirmationBody struct {
	CancelButtonLabel  string `json:"cancelButtonLabel"`
	ConfirmButtonLabel string `json:"confirmButtonLabel"`
	Prompt             string `json:"prompt"`
}

ActionConfirmationBody defines model for ActionConfirmationBody.

type ActionHookActionBody

type ActionHookActionBody struct {
	Confirmation          *ActionConfirmationBody        `json:"confirmation,omitempty"`
	HttpMethod            ActionHookActionBodyHttpMethod `json:"httpMethod"`
	Label                 *string                        `json:"label,omitempty"`
	PropertyNamesIncluded []string                       `json:"propertyNamesIncluded"`
	Type                  ActionHookActionBodyType       `json:"type"`
	Url                   string                         `json:"url"`
}

ActionHookActionBody defines model for ActionHookActionBody.

type ActionHookActionBodyHttpMethod

type ActionHookActionBodyHttpMethod string

ActionHookActionBodyHttpMethod defines model for ActionHookActionBody.HttpMethod.

const (
	ActionHookActionBodyHttpMethodCONNECT ActionHookActionBodyHttpMethod = "CONNECT"

	ActionHookActionBodyHttpMethodDELETE ActionHookActionBodyHttpMethod = "DELETE"

	ActionHookActionBodyHttpMethodGET ActionHookActionBodyHttpMethod = "GET"

	ActionHookActionBodyHttpMethodHEAD ActionHookActionBodyHttpMethod = "HEAD"

	ActionHookActionBodyHttpMethodOPTIONS ActionHookActionBodyHttpMethod = "OPTIONS"

	ActionHookActionBodyHttpMethodPATCH ActionHookActionBodyHttpMethod = "PATCH"

	ActionHookActionBodyHttpMethodPOST ActionHookActionBodyHttpMethod = "POST"

	ActionHookActionBodyHttpMethodPUT ActionHookActionBodyHttpMethod = "PUT"

	ActionHookActionBodyHttpMethodTRACE ActionHookActionBodyHttpMethod = "TRACE"
)

Defines values for ActionHookActionBodyHttpMethod.

type ActionHookActionBodyType

type ActionHookActionBodyType string

ActionHookActionBodyType defines model for ActionHookActionBody.Type.

const (
	ActionHookActionBodyTypeACTIONHOOK ActionHookActionBodyType = "ACTION_HOOK"
)

Defines values for ActionHookActionBodyType.

type ArchiveCardResponse

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

func (ArchiveCardResponse) Status

func (r ArchiveCardResponse) Status() string

Status returns HTTPResponse.Status

func (ArchiveCardResponse) StatusCode

func (r ArchiveCardResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CardActions

type CardActions struct {
	// A list of URL prefixes that will be accepted for card action URLs. If your data fetch response includes an action URL that doesn't begin with one of these values, it will result in an error and the card will not be displayed.
	BaseUrls []string `json:"baseUrls"`
}

Configuration for custom user actions on cards.

type CardCreateRequest

type CardCreateRequest struct {
	// Configuration for custom user actions on cards.
	Actions CardActions `json:"actions"`

	// Configuration for displayed info on a card
	Display CardDisplayBody `json:"display"`

	// Configuration for this card's data fetch request.
	Fetch CardFetchBody `json:"fetch"`

	// The top-level title for this card. Displayed to users in the CRM UI.
	Title string `json:"title"`
}

State of card definition to be created

type CardDisplayBody

type CardDisplayBody struct {
	// Card display properties. These will will be rendered as "label : value" pairs in the card UI. See the [example card](#) in the overview docs for more details.
	Properties []CardDisplayProperty `json:"properties"`
}

Configuration for displayed info on a card

type CardDisplayProperty

type CardDisplayProperty struct {
	// Type of data represented by this property.
	DataType CardDisplayPropertyDataType `json:"dataType"`

	// The label for this property as you'd like it displayed to users.
	Label string `json:"label"`

	// An internal identifier for this property. This value must be unique TODO.
	Name string `json:"name"`

	// An array of available options that can be displayed. Only used in when `dataType` is `STATUS`.
	Options []DisplayOption `json:"options"`
}

Definition for a card display property.

type CardDisplayPropertyDataType

type CardDisplayPropertyDataType string

Type of data represented by this property.

const (
	CardDisplayPropertyDataTypeBOOLEAN CardDisplayPropertyDataType = "BOOLEAN"

	CardDisplayPropertyDataTypeCURRENCY CardDisplayPropertyDataType = "CURRENCY"

	CardDisplayPropertyDataTypeDATE CardDisplayPropertyDataType = "DATE"

	CardDisplayPropertyDataTypeDATETIME CardDisplayPropertyDataType = "DATETIME"

	CardDisplayPropertyDataTypeEMAIL CardDisplayPropertyDataType = "EMAIL"

	CardDisplayPropertyDataTypeLINK CardDisplayPropertyDataType = "LINK"

	CardDisplayPropertyDataTypeNUMERIC CardDisplayPropertyDataType = "NUMERIC"

	CardDisplayPropertyDataTypeSTATUS CardDisplayPropertyDataType = "STATUS"

	CardDisplayPropertyDataTypeSTRING CardDisplayPropertyDataType = "STRING"
)

Defines values for CardDisplayPropertyDataType.

type CardFetchBody

type CardFetchBody struct {
	// An array of CRM object types where this card should be displayed. HubSpot will call your data fetch URL whenever a user visits a record page of the types defined here.
	ObjectTypes []CardObjectTypeBody `json:"objectTypes"`

	// URL to a service endpoints that will respond with card details. HubSpot will call this endpoint each time a user visits a CRM record page where this card should be displayed.
	TargetUrl string `json:"targetUrl"`
}

Configuration for this card's data fetch request.

type CardFetchBodyPatch

type CardFetchBodyPatch struct {
	// An array of CRM object types where this card should be displayed. HubSpot will call your target URL whenever a user visits a record page of the types defined here.
	ObjectTypes []CardObjectTypeBody `json:"objectTypes"`

	// URL to a service endpoint that will respond with details for this card. HubSpot will call this endpoint each time a user visits a CRM record page where this card should be displayed.
	TargetUrl *string `json:"targetUrl,omitempty"`
}

Variant of CardFetchBody with fields as optional for patches

type CardListResponse

type CardListResponse struct {
	// List of card definitions
	Results []CardResponse `json:"results"`
}

List of card definitions

type CardObjectTypeBody

type CardObjectTypeBody struct {
	// A CRM object type where this card should be displayed.
	Name CardObjectTypeBodyName `json:"name"`

	// An array of properties that should be sent to this card's target URL when the data fetch request is made. Must be valid properties for the corresponding CRM object type.
	PropertiesToSend []string `json:"propertiesToSend"`
}

CardObjectTypeBody defines model for CardObjectTypeBody.

type CardObjectTypeBodyName

type CardObjectTypeBodyName string

A CRM object type where this card should be displayed.

const (
	CardObjectTypeBodyNameCompanies CardObjectTypeBodyName = "companies"

	CardObjectTypeBodyNameContacts CardObjectTypeBodyName = "contacts"

	CardObjectTypeBodyNameDeals CardObjectTypeBodyName = "deals"

	CardObjectTypeBodyNameTickets CardObjectTypeBodyName = "tickets"
)

Defines values for CardObjectTypeBodyName.

type CardPatchRequest

type CardPatchRequest struct {
	// Configuration for custom user actions on cards.
	Actions *CardActions `json:"actions,omitempty"`

	// Configuration for displayed info on a card
	Display *CardDisplayBody `json:"display,omitempty"`

	// Variant of CardFetchBody with fields as optional for patches
	Fetch *CardFetchBodyPatch `json:"fetch,omitempty"`

	// The top-level title for this card. Displayed to users in the CRM UI.
	Title *string `json:"title,omitempty"`
}

Body for a patch with optional fields

type CardResponse

type CardResponse struct {
	// Configuration for custom user actions on cards.
	Actions CardActions `json:"actions"`

	// When this card was created.
	CreatedAt *time.Time `json:"createdAt,omitempty"`

	// Configuration for displayed info on a card
	Display CardDisplayBody `json:"display"`

	// Configuration for this card's data fetch request.
	Fetch CardFetchBody `json:"fetch"`

	// Generated unique ID for card.
	Id string `json:"id"`

	// Displayed title of this card.
	Title string `json:"title"`

	// The last time this card was updated.
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
}

Current state of Card Definition

type Client

type Client client.Client

Client conforms to the OpenAPI3 specification for this service.

func NewClient

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

NewClient creates a new Client with reasonable defaults.

func (*Client) ArchiveCard

func (c *Client) ArchiveCard(ctx context.Context, appId int32, cardId string, reqEditors ...client.RequestEditorFn) (*ArchiveCardResponse, error)

ArchiveCard request returning *ArchiveCardResponse

func (*Client) CreateApp

func (c *Client) CreateApp(ctx context.Context, appId int32, body CreateAppJSONRequestBody, reqEditors ...client.RequestEditorFn) (*CreateAppResponse, error)

func (*Client) CreateAppWithBody

func (c *Client) CreateAppWithBody(ctx context.Context, appId int32, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*CreateAppResponse, error)

CreateAppWithBody request with arbitrary body returning *CreateAppResponse

func (*Client) GetAllApp

func (c *Client) GetAllApp(ctx context.Context, appId int32, reqEditors ...client.RequestEditorFn) (*GetAllAppResponse, error)

GetAllApp request returning *GetAllAppResponse

func (*Client) GetCard

func (c *Client) GetCard(ctx context.Context, appId int32, cardId string, reqEditors ...client.RequestEditorFn) (*GetCardResponse, error)

GetCard request returning *GetCardResponse

func (*Client) GetCardsSampleResponseSampleResponse

func (c *Client) GetCardsSampleResponseSampleResponse(ctx context.Context, reqEditors ...client.RequestEditorFn) (*GetCardsSampleResponseSampleResponseResponse, error)

GetCardsSampleResponseSampleResponse request returning *GetCardsSampleResponseSampleResponseResponse

func (*Client) UpdateCard

func (c *Client) UpdateCard(ctx context.Context, appId int32, cardId string, body UpdateCardJSONRequestBody, reqEditors ...client.RequestEditorFn) (*UpdateCardResponse, error)

func (*Client) UpdateCardWithBody

func (c *Client) UpdateCardWithBody(ctx context.Context, appId int32, cardId string, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*UpdateCardResponse, error)

UpdateCardWithBody request with arbitrary body returning *UpdateCardResponse

type ClientInterface

type ClientInterface interface {
	// GetCardsSampleResponseSampleResponse request
	GetCardsSampleResponseSampleResponse(ctx context.Context, reqEditors ...client.RequestEditorFn) (*GetCardsSampleResponseSampleResponseResponse, error)

	// GetAllApp request
	GetAllApp(ctx context.Context, appId int32, reqEditors ...client.RequestEditorFn) (*GetAllAppResponse, error)

	// CreateApp request with any body
	CreateAppWithBody(ctx context.Context, appId int32, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*CreateAppResponse, error)
	CreateApp(ctx context.Context, appId int32, body CreateAppJSONRequestBody, reqEditors ...client.RequestEditorFn) (*CreateAppResponse, error)

	// ArchiveCard request
	ArchiveCard(ctx context.Context, appId int32, cardId string, reqEditors ...client.RequestEditorFn) (*ArchiveCardResponse, error)

	// GetCard request
	GetCard(ctx context.Context, appId int32, cardId string, reqEditors ...client.RequestEditorFn) (*GetCardResponse, error)

	// UpdateCard request with any body
	UpdateCardWithBody(ctx context.Context, appId int32, cardId string, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*UpdateCardResponse, error)
	UpdateCard(ctx context.Context, appId int32, cardId string, body UpdateCardJSONRequestBody, reqEditors ...client.RequestEditorFn) (*UpdateCardResponse, error)
}

ClientInterface interface specification for the client.

type CreateAppJSONBody

type CreateAppJSONBody CardCreateRequest

CreateAppJSONBody defines parameters for CreateApp.

type CreateAppJSONRequestBody

type CreateAppJSONRequestBody CreateAppJSONBody

CreateAppJSONRequestBody defines body for CreateApp for application/json ContentType.

type CreateAppResponse

type CreateAppResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *CardResponse
}

func (CreateAppResponse) Status

func (r CreateAppResponse) Status() string

Status returns HTTPResponse.Status

func (CreateAppResponse) StatusCode

func (r CreateAppResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DisplayOption

type DisplayOption struct {
	// The text that will be displayed to users for this option.
	Label string `json:"label"`

	// JSON-friendly unique name for option.
	Name string `json:"name"`

	// The type of status.
	Type DisplayOptionType `json:"type"`
}

Option definition for STATUS dataTypes.

type DisplayOptionType

type DisplayOptionType string

The type of status.

const (
	DisplayOptionTypeDANGER DisplayOptionType = "DANGER"

	DisplayOptionTypeDEFAULT DisplayOptionType = "DEFAULT"

	DisplayOptionTypeINFO DisplayOptionType = "INFO"

	DisplayOptionTypeSUCCESS DisplayOptionType = "SUCCESS"

	DisplayOptionTypeWARNING DisplayOptionType = "WARNING"
)

Defines values for DisplayOptionType.

type Error

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

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

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

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

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

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

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

Error defines model for Error.

type ErrorDetail

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

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

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

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

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

ErrorDetail defines model for ErrorDetail.

type ErrorDetail_Context

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

Context about the error condition

func (ErrorDetail_Context) Get

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

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

func (ErrorDetail_Context) MarshalJSON

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

Override default JSON handling for ErrorDetail_Context to handle AdditionalProperties

func (*ErrorDetail_Context) Set

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

Setter for additional properties for ErrorDetail_Context

func (*ErrorDetail_Context) UnmarshalJSON

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

Override default JSON handling for ErrorDetail_Context to handle AdditionalProperties

type Error_Context

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

Context about the error condition

func (Error_Context) Get

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

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

func (Error_Context) MarshalJSON

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

Override default JSON handling for Error_Context to handle AdditionalProperties

func (*Error_Context) Set

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

Setter for additional properties for Error_Context

func (*Error_Context) UnmarshalJSON

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

Override default JSON handling for Error_Context to handle AdditionalProperties

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

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

func (Error_Links) Get

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

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

func (Error_Links) MarshalJSON

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

Override default JSON handling for Error_Links to handle AdditionalProperties

func (*Error_Links) Set

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

Setter for additional properties for Error_Links

func (*Error_Links) UnmarshalJSON

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

Override default JSON handling for Error_Links to handle AdditionalProperties

type GetAllAppResponse

type GetAllAppResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CardListResponse
}

func (GetAllAppResponse) Status

func (r GetAllAppResponse) Status() string

Status returns HTTPResponse.Status

func (GetAllAppResponse) StatusCode

func (r GetAllAppResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetCardResponse

type GetCardResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CardResponse
}

func (GetCardResponse) Status

func (r GetCardResponse) Status() string

Status returns HTTPResponse.Status

func (GetCardResponse) StatusCode

func (r GetCardResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetCardsSampleResponseSampleResponseResponse

type GetCardsSampleResponseSampleResponseResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *IntegratorCardPayloadResponse
}

func (GetCardsSampleResponseSampleResponseResponse) Status

Status returns HTTPResponse.Status

func (GetCardsSampleResponseSampleResponseResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type IFrameActionBody

type IFrameActionBody struct {
	Height                int32                `json:"height"`
	Label                 *string              `json:"label,omitempty"`
	PropertyNamesIncluded []string             `json:"propertyNamesIncluded"`
	Type                  IFrameActionBodyType `json:"type"`
	Url                   string               `json:"url"`
	Width                 int32                `json:"width"`
}

IFrameActionBody defines model for IFrameActionBody.

type IFrameActionBodyType

type IFrameActionBodyType string

IFrameActionBodyType defines model for IFrameActionBody.Type.

const (
	IFrameActionBodyTypeIFRAME IFrameActionBodyType = "IFRAME"
)

Defines values for IFrameActionBodyType.

type IntegratorCardPayloadResponse

type IntegratorCardPayloadResponse struct {
	// URL to a page the integrator has built that displays all details for this card. This URL will be displayed to users under a `See more [x]` link if there are more than five items in your response, where `[x]` is the value of `itemLabel`.
	AllItemsLinkUrl *string `json:"allItemsLinkUrl,omitempty"`

	// The label to be used for the `allItemsLinkUrl` link (e.g. 'See more tickets'). If not provided, this falls back to the card's title.
	CardLabel       *string                                       `json:"cardLabel,omitempty"`
	ResponseVersion *IntegratorCardPayloadResponseResponseVersion `json:"responseVersion,omitempty"`

	// A list of up to five valid card sub categories.
	Sections        *[]IntegratorObjectResult `json:"sections,omitempty"`
	TopLevelActions *TopLevelActions          `json:"topLevelActions,omitempty"`

	// The total number of card properties that will be sent in this response.
	TotalCount int32 `json:"totalCount"`
}

The card details payload, sent to HubSpot by an app in response to a data fetch request when a user visits a CRM record page.

type IntegratorCardPayloadResponseResponseVersion

type IntegratorCardPayloadResponseResponseVersion string

IntegratorCardPayloadResponseResponseVersion defines model for IntegratorCardPayloadResponse.ResponseVersion.

const (
	IntegratorCardPayloadResponseResponseVersionV1 IntegratorCardPayloadResponseResponseVersion = "v1"

	IntegratorCardPayloadResponseResponseVersionV3 IntegratorCardPayloadResponseResponseVersion = "v3"
)

Defines values for IntegratorCardPayloadResponseResponseVersion.

type IntegratorObjectResult

type IntegratorObjectResult struct {
	Actions []interface{} `json:"actions"`
	Id      string        `json:"id"`
	LinkUrl *string       `json:"linkUrl,omitempty"`
	Title   string        `json:"title"`
	Tokens  []ObjectToken `json:"tokens"`
}

IntegratorObjectResult defines model for IntegratorObjectResult.

type ObjectToken

type ObjectToken struct {
	DataType *ObjectTokenDataType `json:"dataType,omitempty"`
	Label    *string              `json:"label,omitempty"`
	Name     *string              `json:"name,omitempty"`
	Value    string               `json:"value"`
}

ObjectToken defines model for ObjectToken.

type ObjectTokenDataType

type ObjectTokenDataType string

ObjectTokenDataType defines model for ObjectToken.DataType.

const (
	ObjectTokenDataTypeBOOLEAN ObjectTokenDataType = "BOOLEAN"

	ObjectTokenDataTypeCURRENCY ObjectTokenDataType = "CURRENCY"

	ObjectTokenDataTypeDATE ObjectTokenDataType = "DATE"

	ObjectTokenDataTypeDATETIME ObjectTokenDataType = "DATETIME"

	ObjectTokenDataTypeEMAIL ObjectTokenDataType = "EMAIL"

	ObjectTokenDataTypeLINK ObjectTokenDataType = "LINK"

	ObjectTokenDataTypeNUMERIC ObjectTokenDataType = "NUMERIC"

	ObjectTokenDataTypeSTATUS ObjectTokenDataType = "STATUS"

	ObjectTokenDataTypeSTRING ObjectTokenDataType = "STRING"
)

Defines values for ObjectTokenDataType.

type TopLevelActions

type TopLevelActions struct {
	Primary   *interface{}      `json:"primary,omitempty"`
	Secondary []interface{}     `json:"secondary"`
	Settings  *IFrameActionBody `json:"settings,omitempty"`
}

TopLevelActions defines model for TopLevelActions.

type UpdateCardJSONBody

type UpdateCardJSONBody CardPatchRequest

UpdateCardJSONBody defines parameters for UpdateCard.

type UpdateCardJSONRequestBody

type UpdateCardJSONRequestBody UpdateCardJSONBody

UpdateCardJSONRequestBody defines body for UpdateCard for application/json ContentType.

type UpdateCardResponse

type UpdateCardResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CardResponse
}

func (UpdateCardResponse) Status

func (r UpdateCardResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateCardResponse) StatusCode

func (r UpdateCardResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL