calling

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 calling provides primitives to interact with the openapi HTTP API.

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

Package calling 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 ArchiveSettingsResponse 

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

func (ArchiveSettingsResponse) Status 

func (r ArchiveSettingsResponse) Status() string

Status returns HTTPResponse.Status

func (ArchiveSettingsResponse) StatusCode 

func (r ArchiveSettingsResponse) 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) ArchiveSettings 

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

ArchiveSettings request returning *ArchiveSettingsResponse

func (*Client) CreateSettings 

func (c *Client) CreateSettings(ctx context.Context, appId int32, body CreateSettingsJSONRequestBody, reqEditors ...client.RequestEditorFn) (*CreateSettingsResponse, error)

func (*Client) CreateSettingsWithBody 

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

CreateSettingsWithBody request with arbitrary body returning *CreateSettingsResponse

func (*Client) GetSettings 

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

GetSettings request returning *GetSettingsResponse

func (*Client) UpdateSettings 

func (c *Client) UpdateSettings(ctx context.Context, appId int32, body UpdateSettingsJSONRequestBody, reqEditors ...client.RequestEditorFn) (*UpdateSettingsResponse, error)

func (*Client) UpdateSettingsWithBody 

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

UpdateSettingsWithBody request with arbitrary body returning *UpdateSettingsResponse

type ClientInterface 

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

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

	// UpdateSettings request with any body
	UpdateSettingsWithBody(ctx context.Context, appId int32, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*UpdateSettingsResponse, error)
	UpdateSettings(ctx context.Context, appId int32, body UpdateSettingsJSONRequestBody, reqEditors ...client.RequestEditorFn) (*UpdateSettingsResponse, error)

	// CreateSettings request with any body
	CreateSettingsWithBody(ctx context.Context, appId int32, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*CreateSettingsResponse, error)
	CreateSettings(ctx context.Context, appId int32, body CreateSettingsJSONRequestBody, reqEditors ...client.RequestEditorFn) (*CreateSettingsResponse, error)
}

ClientInterface interface specification for the client.

type CreateSettingsJSONBody 

type CreateSettingsJSONBody SettingsRequest

CreateSettingsJSONBody defines parameters for CreateSettings.

type CreateSettingsJSONRequestBody 

type CreateSettingsJSONRequestBody CreateSettingsJSONBody

CreateSettingsJSONRequestBody defines body for CreateSettings for application/json ContentType.

type CreateSettingsResponse 

type CreateSettingsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SettingsResponse
}

func (CreateSettingsResponse) Status 

func (r CreateSettingsResponse) Status() string

Status returns HTTPResponse.Status

func (CreateSettingsResponse) StatusCode 

func (r CreateSettingsResponse) 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 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 GetSettingsResponse 

type GetSettingsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SettingsResponse
}

func (GetSettingsResponse) Status 

func (r GetSettingsResponse) Status() string

Status returns HTTPResponse.Status

func (GetSettingsResponse) StatusCode 

func (r GetSettingsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SettingsPatchRequest 

type SettingsPatchRequest struct {
	// The target height of the iframe that will contain your phone/calling UI.
	Height *int32 `json:"height,omitempty"`

	// When true, your service will appear as an option under the *Call* action in contact records of connected accounts.
	IsReady *bool `json:"isReady,omitempty"`

	// The name of your calling service to display to users.
	Name *string `json:"name,omitempty"`

	// When true, you are indicating that your service is compatible with engagement v2 service and can be used with custom objects.
	SupportsCustomObjects *bool `json:"supportsCustomObjects,omitempty"`

	// The URL to your phone/calling UI, built with the [Calling SDK](#).
	Url *string `json:"url,omitempty"`

	// The target width of the iframe that will contain your phone/calling UI.
	Width *int32 `json:"width,omitempty"`
}

Settings update request

type SettingsRequest 

type SettingsRequest struct {
	// The target height of the iframe that will contain your phone/calling UI.
	Height *int32 `json:"height,omitempty"`

	// When true, your service will appear as an option under the *Call* action in contact records of connected accounts.
	IsReady *bool `json:"isReady,omitempty"`

	// The name of your calling service to display to users.
	Name string `json:"name"`

	// When true, you are indicating that your service is compatible with engagement v2 service and can be used with custom objects.
	SupportsCustomObjects *bool `json:"supportsCustomObjects,omitempty"`

	// The URL to your phone/calling UI, built with the [Calling SDK](#).
	Url string `json:"url"`

	// The target width of the iframe that will contain your phone/calling UI.
	Width *int32 `json:"width,omitempty"`
}

Settings create request

type SettingsResponse 

type SettingsResponse struct {
	// When this calling extension was created.
	CreatedAt time.Time `json:"createdAt"`

	// The target height of the iframe that will contain your phone/calling UI.
	Height int32 `json:"height"`

	// When true, your service will appear as an option under the *Call* action in contact records of connected accounts.
	IsReady bool `json:"isReady"`

	// The name of your calling service to display to users.
	Name string `json:"name"`

	// When true, you are indicating that your service is compatible with engagement v2 service and can be used with custom objects.
	SupportsCustomObjects bool `json:"supportsCustomObjects"`

	// The last time the settings for this calling extension were modified.
	UpdatedAt time.Time `json:"updatedAt"`

	// The URL to your phone/calling UI, built with the [Calling SDK](#).
	Url string `json:"url"`

	// The target width of the iframe that will contain your phone/calling UI.
	Width int32 `json:"width"`
}

Current settings state

type UpdateSettingsJSONBody 

type UpdateSettingsJSONBody SettingsPatchRequest

UpdateSettingsJSONBody defines parameters for UpdateSettings.

type UpdateSettingsJSONRequestBody 

type UpdateSettingsJSONRequestBody UpdateSettingsJSONBody

UpdateSettingsJSONRequestBody defines body for UpdateSettings for application/json ContentType.

type UpdateSettingsResponse 

type UpdateSettingsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SettingsResponse
}

func (UpdateSettingsResponse) Status 

func (r UpdateSettingsResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateSettingsResponse) StatusCode 

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