Documentation ¶
Overview ¶
Package owners provides primitives to interact with the openapi HTTP API.
Code generated by github.com/faetools/devtool version (devel) DO NOT EDIT.
Package owners provides primitives to interact with the openapi HTTP API.
Code generated by github.com/faetools/devtool version (devel) DO NOT EDIT.
Index ¶
- Constants
- type Client
- type ClientInterface
- type CollectionResponsePublicOwnerForwardPaging
- type Error
- type ErrorDetail
- type ErrorDetail_Context
- type Error_Context
- type Error_Links
- type ForwardPaging
- type GetOwnerParams
- type GetOwnerParamsIdProperty
- type GetOwnerResponse
- type ListParams
- type ListResponse
- type NextPage
- type PublicOwner
- type PublicTeam
- type PublicTeamMembership
Constants ¶
const ( HapikeyScopes = "hapikey.Scopes" Oauth2Scopes = "oauth2.Scopes" Oauth2_legacyScopes = "oauth2_legacy.Scopes" )
const DefaultServer = "https://api.hubapi.com/"
DefaultServer is the default server to be used.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
Client conforms to the OpenAPI3 specification for this service.
func (*Client) GetOwner ¶
func (c *Client) GetOwner(ctx context.Context, ownerId int32, params *GetOwnerParams, reqEditors ...client.RequestEditorFn) (*GetOwnerResponse, error)
GetOwner request returning *GetOwnerResponse
func (*Client) List ¶
func (c *Client) List(ctx context.Context, params *ListParams, reqEditors ...client.RequestEditorFn) (*ListResponse, error)
List request returning *ListResponse
type ClientInterface ¶
type ClientInterface interface { // List request List(ctx context.Context, params *ListParams, reqEditors ...client.RequestEditorFn) (*ListResponse, error) // GetOwner request GetOwner(ctx context.Context, ownerId int32, params *GetOwnerParams, reqEditors ...client.RequestEditorFn) (*GetOwnerResponse, error) }
ClientInterface interface specification for the client.
type CollectionResponsePublicOwnerForwardPaging ¶
type CollectionResponsePublicOwnerForwardPaging struct { Paging *ForwardPaging `json:"paging,omitempty"` Results []PublicOwner `json:"results"` }
CollectionResponsePublicOwnerForwardPaging defines model for CollectionResponsePublicOwnerForwardPaging.
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 ¶
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 ForwardPaging ¶
type ForwardPaging struct {
Next *NextPage `json:"next,omitempty"`
}
ForwardPaging defines model for ForwardPaging.
type GetOwnerParams ¶
type GetOwnerParams struct { IdProperty *GetOwnerParamsIdProperty `json:"idProperty,omitempty"` // Whether to return only results that have been archived. Archived *bool `json:"archived,omitempty"` }
GetOwnerParams defines parameters for GetOwner.
type GetOwnerParamsIdProperty ¶
type GetOwnerParamsIdProperty string
GetOwnerParamsIdProperty defines parameters for GetOwner.
type GetOwnerResponse ¶
type GetOwnerResponse struct { Body []byte HTTPResponse *http.Response JSON200 *PublicOwner }
func (GetOwnerResponse) Status ¶
func (r GetOwnerResponse) Status() string
Status returns HTTPResponse.Status
func (GetOwnerResponse) StatusCode ¶
func (r GetOwnerResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ListParams ¶
type ListParams struct { // Filter by email address (optional) Email *string `json:"email,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"` // The maximum number of results to display per page. Limit *int32 `json:"limit,omitempty"` // Whether to return only results that have been archived. Archived *bool `json:"archived,omitempty"` }
ListParams defines parameters for List.
type ListResponse ¶
type ListResponse struct { Body []byte HTTPResponse *http.Response JSON200 *CollectionResponsePublicOwnerForwardPaging }
func (ListResponse) Status ¶
func (r ListResponse) Status() string
Status returns HTTPResponse.Status
func (ListResponse) StatusCode ¶
func (r ListResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PublicOwner ¶
type PublicOwner struct { Archived bool `json:"archived"` CreatedAt time.Time `json:"createdAt"` Email *string `json:"email,omitempty"` FirstName *string `json:"firstName,omitempty"` Id string `json:"id"` LastName *string `json:"lastName,omitempty"` Teams *[]PublicTeam `json:"teams,omitempty"` UpdatedAt time.Time `json:"updatedAt"` UserId *int32 `json:"userId,omitempty"` }
PublicOwner defines model for PublicOwner.
type PublicTeam ¶
type PublicTeam struct { Id string `json:"id"` Membership *PublicTeamMembership `json:"membership,omitempty"` Name string `json:"name"` }
PublicTeam defines model for PublicTeam.
type PublicTeamMembership ¶
type PublicTeamMembership string
PublicTeamMembership defines model for PublicTeam.Membership.
const ( PublicTeamMembershipCHILD PublicTeamMembership = "CHILD" PublicTeamMembershipPRIMARY PublicTeamMembership = "PRIMARY" PublicTeamMembershipSECONDARY PublicTeamMembership = "SECONDARY" )
Defines values for PublicTeamMembership.