videoconferencing

Documentation

Overview

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

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

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

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

Index

• Constants
• type ArchiveAppResponse
  • func (r ArchiveAppResponse) Status() string
  • func (r ArchiveAppResponse) StatusCode() int
• type Client
  • func NewClient(opts ...client.Option) (*Client, error)
  • func (c *Client) ArchiveApp(ctx context.Context, appId int32, reqEditors ...client.RequestEditorFn) (*ArchiveAppResponse, error)
  • func (c *Client) GetApp(ctx context.Context, appId int32, reqEditors ...client.RequestEditorFn) (*GetAppResponse, error)
  • func (c *Client) ReplaceApp(ctx context.Context, appId int32, body ReplaceAppJSONRequestBody, ...) (*ReplaceAppResponse, error)
  • func (c *Client) ReplaceAppWithBody(ctx context.Context, appId int32, contentType string, body io.Reader, ...) (*ReplaceAppResponse, error)
• type ClientInterface
• type Error
• type ErrorDetail
• type ErrorDetail_Context
  • func (a ErrorDetail_Context) Get(fieldName string) (value []string, found bool)
  • func (a ErrorDetail_Context) MarshalJSON() ([]byte, error)
  • func (a *ErrorDetail_Context) Set(fieldName string, value []string)
  • func (a *ErrorDetail_Context) UnmarshalJSON(b []byte) error
• type Error_Context
  • func (a Error_Context) Get(fieldName string) (value []string, found bool)
  • func (a Error_Context) MarshalJSON() ([]byte, error)
  • func (a *Error_Context) Set(fieldName string, value []string)
  • func (a *Error_Context) UnmarshalJSON(b []byte) error
• type Error_Links
  • func (a Error_Links) Get(fieldName string) (value string, found bool)
  • func (a Error_Links) MarshalJSON() ([]byte, error)
  • func (a *Error_Links) Set(fieldName string, value string)
  • func (a *Error_Links) UnmarshalJSON(b []byte) error
• type ExternalSettings
• type GetAppResponse
  • func (r GetAppResponse) Status() string
  • func (r GetAppResponse) StatusCode() int
• type ReplaceAppJSONBody
• type ReplaceAppJSONRequestBody
• type ReplaceAppResponse
  • func (r ReplaceAppResponse) Status() string
  • func (r ReplaceAppResponse) StatusCode() int

Constants

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

DefaultServer is the default server to be used.

const (
	HapikeyScopes = "hapikey.Scopes"
)

Types

type ArchiveAppResponse

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

func (ArchiveAppResponse) Status

func (r ArchiveAppResponse) Status() string

Status returns HTTPResponse.Status

func (ArchiveAppResponse) StatusCode

func (r ArchiveAppResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

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

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

ArchiveApp request returning *ArchiveAppResponse

func (*Client) GetApp

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

GetApp request returning *GetAppResponse

func (*Client) ReplaceApp

func (c *Client) ReplaceApp(ctx context.Context, appId int32, body ReplaceAppJSONRequestBody, reqEditors ...client.RequestEditorFn) (*ReplaceAppResponse, error)

func (*Client) ReplaceAppWithBody

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

ReplaceAppWithBody request with arbitrary body returning *ReplaceAppResponse

type ClientInterface

type ClientInterface interface {
	// ArchiveApp request
	ArchiveApp(ctx context.Context, appId int32, reqEditors ...client.RequestEditorFn) (*ArchiveAppResponse, error)

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

	// ReplaceApp request with any body
	ReplaceAppWithBody(ctx context.Context, appId int32, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*ReplaceAppResponse, error)
	ReplaceApp(ctx context.Context, appId int32, body ReplaceAppJSONRequestBody, reqEditors ...client.RequestEditorFn) (*ReplaceAppResponse, error)
}

ClientInterface interface specification for the client.

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

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 ExternalSettings

type ExternalSettings struct {
	// The URL that HubSpot will send requests to create a new video conference.
	CreateMeetingUrl string `json:"createMeetingUrl"`

	// The URL that HubSpot will send notifications of meetings that have been deleted in HubSpot.
	DeleteMeetingUrl *string `json:"deleteMeetingUrl,omitempty"`

	// The URL that HubSpot will send updates to existing meetings. Typically called when the user changes the topic or times of a meeting.
	UpdateMeetingUrl *string `json:"updateMeetingUrl,omitempty"`

	// The URL that HubSpot will use to verify that a user exists in the video conference application.
	UserVerifyUrl *string `json:"userVerifyUrl,omitempty"`
}

The URLs of the various actions provided by the video conferencing application. All URLs must use the `https` protocol.

type GetAppResponse

type GetAppResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ExternalSettings
}

func (GetAppResponse) Status

func (r GetAppResponse) Status() string

Status returns HTTPResponse.Status

func (GetAppResponse) StatusCode

func (r GetAppResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ReplaceAppJSONBody

type ReplaceAppJSONBody ExternalSettings

ReplaceAppJSONBody defines parameters for ReplaceApp.

type ReplaceAppJSONRequestBody

type ReplaceAppJSONRequestBody ReplaceAppJSONBody

ReplaceAppJSONRequestBody defines body for ReplaceApp for application/json ContentType.

type ReplaceAppResponse

type ReplaceAppResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ExternalSettings
}

func (ReplaceAppResponse) Status

func (r ReplaceAppResponse) Status() string

Status returns HTTPResponse.Status

func (ReplaceAppResponse) StatusCode

func (r ReplaceAppResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode