calling

package
v0.0.0-...-abe38a1 Latest Latest
Warning

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

 Go to latest Published: Feb 3, 2024 License: MIT Imports: 23 Imported by: 0

README

Go API client for calling

Provides a way for apps to add custom calling options to a contact record. This works in conjunction with the Calling SDK, which is used to build your phone/calling UI. The endpoints here allow your service to appear as an option to HubSpot users when they access the Call action on a contact record. Once accessed, your custom phone/calling UI will be displayed in an iframe at the specified URL with the specified dimensions on that record.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: v3
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import calling "github.com/GIT_USER_ID/GIT_REPO_ID"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), calling.ContextServerIndex, 1)
Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), calling.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), calling.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), calling.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://api.hubapi.com

Class Method HTTP request Description
RecordingSettingsApi GetCrmV3ExtensionsCallingAppIdSettingsRecordingGetUrlFormat Get /crm/v3/extensions/calling/{appId}/settings/recording
RecordingSettingsApi PatchCrmV3ExtensionsCallingAppIdSettingsRecordingUpdateUrlFormat Patch /crm/v3/extensions/calling/{appId}/settings/recording
RecordingSettingsApi PostCrmV3ExtensionsCallingAppIdSettingsRecordingRegisterUrlFormat Post /crm/v3/extensions/calling/{appId}/settings/recording
SettingsApi Archive Delete /crm/v3/extensions/calling/{appId}/settings Delete calling settings
SettingsApi Create Post /crm/v3/extensions/calling/{appId}/settings Configure a calling extension
SettingsApi GetByID Get /crm/v3/extensions/calling/{appId}/settings Get calling settings
SettingsApi Update Patch /crm/v3/extensions/calling/{appId}/settings Update settings

Documentation For Models

Documentation For Authorization

developer_hapikey
  • Type: API key
  • API key parameter name: hapikey
  • Location: URL query string

Note, each API key must be added to a map of map[string]APIKey where the key is: hapikey and passed in as the auth context for each request.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKeys takes a string apikey as authentication for the request
	ContextAPIKeys = contextKey("apiKeys")

	// ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request.
	ContextHttpSignatureAuth = contextKey("httpsignature")

	// ContextServerIndex uses a server configuration from the index.
	ContextServerIndex = contextKey("serverIndex")

	// ContextOperationServerIndices uses a server configuration from the index mapping.
	ContextOperationServerIndices = contextKey("serverOperationIndices")

	// ContextServerVariables overrides a server configuration variables.
	ContextServerVariables = contextKey("serverVariables")

	// ContextOperationServerVariables overrides a server configuration variables using operation specific values.
	ContextOperationServerVariables = contextKey("serverOperationVariables")
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

func PtrBool 

func PtrBool(v bool) *bool

PtrBool is a helper routine that returns a pointer to given boolean value.

func PtrFloat32 

func PtrFloat32(v float32) *float32

PtrFloat32 is a helper routine that returns a pointer to given float value.

func PtrFloat64 

func PtrFloat64(v float64) *float64

PtrFloat64 is a helper routine that returns a pointer to given float value.

func PtrInt 

func PtrInt(v int) *int

PtrInt is a helper routine that returns a pointer to given integer value.

func PtrInt32 

func PtrInt32(v int32) *int32

PtrInt32 is a helper routine that returns a pointer to given integer value.

func PtrInt64 

func PtrInt64(v int64) *int64

PtrInt64 is a helper routine that returns a pointer to given integer value.

func PtrString 

func PtrString(v string) *string

PtrString is a helper routine that returns a pointer to given string value.

func PtrTime 

func PtrTime(v time.Time) *time.Time

PtrTime is helper routine that returns a pointer to given Time value.

Types

type APIClient 

type APIClient struct {
	RecordingSettingsApi *RecordingSettingsApiService

	SettingsApi *SettingsApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Calling Extensions API vv3 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) GetConfig 

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResponse object.

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type ApiArchiveRequest 

type ApiArchiveRequest struct {
	ApiService *SettingsApiService
	// contains filtered or unexported fields
}

func (ApiArchiveRequest) Execute 

func (r ApiArchiveRequest) Execute() (*http.Response, error)

type ApiCreateRequest 

type ApiCreateRequest struct {
	ApiService *SettingsApiService
	// contains filtered or unexported fields
}

func (ApiCreateRequest) Execute 

func (r ApiCreateRequest) Execute() (*SettingsResponse, *http.Response, error)

func (ApiCreateRequest) SettingsRequest 

func (r ApiCreateRequest) SettingsRequest(settingsRequest SettingsRequest) ApiCreateRequest

Settings state to create with.

type ApiGetByIDRequest 

type ApiGetByIDRequest struct {
	ApiService *SettingsApiService
	// contains filtered or unexported fields
}

func (ApiGetByIDRequest) Execute 

func (r ApiGetByIDRequest) Execute() (*SettingsResponse, *http.Response, error)

type ApiGetCrmV3ExtensionsCallingAppIdSettingsRecordingGetUrlFormatRequest 

type ApiGetCrmV3ExtensionsCallingAppIdSettingsRecordingGetUrlFormatRequest struct {
	ApiService *RecordingSettingsApiService
	// contains filtered or unexported fields
}

func (ApiGetCrmV3ExtensionsCallingAppIdSettingsRecordingGetUrlFormatRequest) Execute 

func (r ApiGetCrmV3ExtensionsCallingAppIdSettingsRecordingGetUrlFormatRequest) Execute() (*RecordingSettingsResponse, *http.Response, error)

type ApiPatchCrmV3ExtensionsCallingAppIdSettingsRecordingUpdateUrlFormatRequest 

type ApiPatchCrmV3ExtensionsCallingAppIdSettingsRecordingUpdateUrlFormatRequest struct {
	ApiService *RecordingSettingsApiService
	// contains filtered or unexported fields
}

func (ApiPatchCrmV3ExtensionsCallingAppIdSettingsRecordingUpdateUrlFormatRequest) Execute 

func (r ApiPatchCrmV3ExtensionsCallingAppIdSettingsRecordingUpdateUrlFormatRequest) Execute() (*RecordingSettingsResponse, *http.Response, error)

func (ApiPatchCrmV3ExtensionsCallingAppIdSettingsRecordingUpdateUrlFormatRequest) RecordingSettingsPatchRequest 

func (r ApiPatchCrmV3ExtensionsCallingAppIdSettingsRecordingUpdateUrlFormatRequest) RecordingSettingsPatchRequest(recordingSettingsPatchRequest RecordingSettingsPatchRequest) ApiPatchCrmV3ExtensionsCallingAppIdSettingsRecordingUpdateUrlFormatRequest

type ApiPostCrmV3ExtensionsCallingAppIdSettingsRecordingRegisterUrlFormatRequest 

type ApiPostCrmV3ExtensionsCallingAppIdSettingsRecordingRegisterUrlFormatRequest struct {
	ApiService *RecordingSettingsApiService
	// contains filtered or unexported fields
}

func (ApiPostCrmV3ExtensionsCallingAppIdSettingsRecordingRegisterUrlFormatRequest) Execute 

func (r ApiPostCrmV3ExtensionsCallingAppIdSettingsRecordingRegisterUrlFormatRequest) Execute() (*RecordingSettingsResponse, *http.Response, error)

func (ApiPostCrmV3ExtensionsCallingAppIdSettingsRecordingRegisterUrlFormatRequest) RecordingSettingsRequest 

func (r ApiPostCrmV3ExtensionsCallingAppIdSettingsRecordingRegisterUrlFormatRequest) RecordingSettingsRequest(recordingSettingsRequest RecordingSettingsRequest) ApiPostCrmV3ExtensionsCallingAppIdSettingsRecordingRegisterUrlFormatRequest

type ApiUpdateRequest 

type ApiUpdateRequest struct {
	ApiService *SettingsApiService
	// contains filtered or unexported fields
}

func (ApiUpdateRequest) Execute 

func (r ApiUpdateRequest) Execute() (*SettingsResponse, *http.Response, error)

func (ApiUpdateRequest) SettingsPatchRequest 

func (r ApiUpdateRequest) SettingsPatchRequest(settingsPatchRequest SettingsPatchRequest) ApiUpdateRequest

Updated details for the settings.

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Configuration 

type Configuration struct {
	Host             string            `json:"host,omitempty"`
	Scheme           string            `json:"scheme,omitempty"`
	DefaultHeader    map[string]string `json:"defaultHeader,omitempty"`
	UserAgent        string            `json:"userAgent,omitempty"`
	Debug            bool              `json:"debug,omitempty"`
	Servers          ServerConfigurations
	OperationServers map[string]ServerConfigurations
	HTTPClient       *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration 

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerURL 

func (c *Configuration) ServerURL(index int, variables map[string]string) (string, error)

ServerURL returns URL based on server settings

func (*Configuration) ServerURLWithContext 

func (c *Configuration) ServerURLWithContext(ctx context.Context, endpoint string) (string, error)

ServerURLWithContext returns a new server URL given an endpoint

type Error 

type Error struct {
	// A specific category that contains more specific detail about the error
	SubCategory *string `json:"subCategory,omitempty"`
	// Context about the error condition
	Context *map[string][]string `json:"context,omitempty"`
	// A unique identifier for the request. Include this value with any error reports or support tickets
	CorrelationId string `json:"correlationId"`
	// A map of link names to associated URIs containing documentation about the error or recommended remediation steps
	Links *map[string]string `json:"links,omitempty"`
	// A human readable message describing the error along with remediation steps where appropriate
	Message string `json:"message"`
	// The error category
	Category string `json:"category"`
	// further information about the error
	Errors []ErrorDetail `json:"errors,omitempty"`
}

Error struct for Error

func NewError 

func NewError(correlationId string, message string, category string) *Error

NewError instantiates a new Error object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewErrorWithDefaults 

func NewErrorWithDefaults() *Error

NewErrorWithDefaults instantiates a new Error object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Error) GetCategory 

func (o *Error) GetCategory() string

GetCategory returns the Category field value

func (*Error) GetCategoryOk 

func (o *Error) GetCategoryOk() (*string, bool)

GetCategoryOk returns a tuple with the Category field value and a boolean to check if the value has been set.

func (*Error) GetContext 

func (o *Error) GetContext() map[string][]string

GetContext returns the Context field value if set, zero value otherwise.

func (*Error) GetContextOk 

func (o *Error) GetContextOk() (*map[string][]string, bool)

GetContextOk returns a tuple with the Context field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Error) GetCorrelationId 

func (o *Error) GetCorrelationId() string

GetCorrelationId returns the CorrelationId field value

func (*Error) GetCorrelationIdOk 

func (o *Error) GetCorrelationIdOk() (*string, bool)

GetCorrelationIdOk returns a tuple with the CorrelationId field value and a boolean to check if the value has been set.

func (*Error) GetErrors 

func (o *Error) GetErrors() []ErrorDetail

GetErrors returns the Errors field value if set, zero value otherwise.

func (*Error) GetErrorsOk 

func (o *Error) GetErrorsOk() ([]ErrorDetail, bool)

GetErrorsOk returns a tuple with the Errors field value if set, nil otherwise and a boolean to check if the value has been set. 

func (o *Error) GetLinks() map[string]string

GetLinks returns the Links field value if set, zero value otherwise.

func (*Error) GetLinksOk 

func (o *Error) GetLinksOk() (*map[string]string, bool)

GetLinksOk returns a tuple with the Links field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Error) GetMessage 

func (o *Error) GetMessage() string

GetMessage returns the Message field value

func (*Error) GetMessageOk 

func (o *Error) GetMessageOk() (*string, bool)

GetMessageOk returns a tuple with the Message field value and a boolean to check if the value has been set.

func (*Error) GetSubCategory 

func (o *Error) GetSubCategory() string

GetSubCategory returns the SubCategory field value if set, zero value otherwise.

func (*Error) GetSubCategoryOk 

func (o *Error) GetSubCategoryOk() (*string, bool)

GetSubCategoryOk returns a tuple with the SubCategory field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Error) HasContext 

func (o *Error) HasContext() bool

HasContext returns a boolean if a field has been set.

func (*Error) HasErrors 

func (o *Error) HasErrors() bool

HasErrors returns a boolean if a field has been set. 

func (o *Error) HasLinks() bool

HasLinks returns a boolean if a field has been set.

func (*Error) HasSubCategory 

func (o *Error) HasSubCategory() bool

HasSubCategory returns a boolean if a field has been set.

func (Error) MarshalJSON 

func (o Error) MarshalJSON() ([]byte, error)

func (*Error) SetCategory 

func (o *Error) SetCategory(v string)

SetCategory sets field value

func (*Error) SetContext 

func (o *Error) SetContext(v map[string][]string)

SetContext gets a reference to the given map[string][]string and assigns it to the Context field.

func (*Error) SetCorrelationId 

func (o *Error) SetCorrelationId(v string)

SetCorrelationId sets field value

func (*Error) SetErrors 

func (o *Error) SetErrors(v []ErrorDetail)

SetErrors gets a reference to the given []ErrorDetail and assigns it to the Errors field. 

func (o *Error) SetLinks(v map[string]string)

SetLinks gets a reference to the given map[string]string and assigns it to the Links field.

func (*Error) SetMessage 

func (o *Error) SetMessage(v string)

SetMessage sets field value

func (*Error) SetSubCategory 

func (o *Error) SetSubCategory(v string)

SetSubCategory gets a reference to the given string and assigns it to the SubCategory field.

type ErrorDetail 

type ErrorDetail struct {
	// A specific category that contains more specific detail about the error
	SubCategory *string `json:"subCategory,omitempty"`
	// The status code associated with the error detail
	Code *string `json:"code,omitempty"`
	// The name of the field or parameter in which the error was found.
	In *string `json:"in,omitempty"`
	// Context about the error condition
	Context *map[string][]string `json:"context,omitempty"`
	// A human readable message describing the error along with remediation steps where appropriate
	Message string `json:"message"`
}

ErrorDetail struct for ErrorDetail

func NewErrorDetail 

func NewErrorDetail(message string) *ErrorDetail

NewErrorDetail instantiates a new ErrorDetail object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewErrorDetailWithDefaults 

func NewErrorDetailWithDefaults() *ErrorDetail

NewErrorDetailWithDefaults instantiates a new ErrorDetail object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ErrorDetail) GetCode 

func (o *ErrorDetail) GetCode() string

GetCode returns the Code field value if set, zero value otherwise.

func (*ErrorDetail) GetCodeOk 

func (o *ErrorDetail) GetCodeOk() (*string, bool)

GetCodeOk returns a tuple with the Code field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ErrorDetail) GetContext 

func (o *ErrorDetail) GetContext() map[string][]string

GetContext returns the Context field value if set, zero value otherwise.

func (*ErrorDetail) GetContextOk 

func (o *ErrorDetail) GetContextOk() (*map[string][]string, bool)

GetContextOk returns a tuple with the Context field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ErrorDetail) GetIn 

func (o *ErrorDetail) GetIn() string

GetIn returns the In field value if set, zero value otherwise.

func (*ErrorDetail) GetInOk 

func (o *ErrorDetail) GetInOk() (*string, bool)

GetInOk returns a tuple with the In field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ErrorDetail) GetMessage 

func (o *ErrorDetail) GetMessage() string

GetMessage returns the Message field value

func (*ErrorDetail) GetMessageOk 

func (o *ErrorDetail) GetMessageOk() (*string, bool)

GetMessageOk returns a tuple with the Message field value and a boolean to check if the value has been set.

func (*ErrorDetail) GetSubCategory 

func (o *ErrorDetail) GetSubCategory() string

GetSubCategory returns the SubCategory field value if set, zero value otherwise.

func (*ErrorDetail) GetSubCategoryOk 

func (o *ErrorDetail) GetSubCategoryOk() (*string, bool)

GetSubCategoryOk returns a tuple with the SubCategory field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ErrorDetail) HasCode 

func (o *ErrorDetail) HasCode() bool

HasCode returns a boolean if a field has been set.

func (*ErrorDetail) HasContext 

func (o *ErrorDetail) HasContext() bool

HasContext returns a boolean if a field has been set.

func (*ErrorDetail) HasIn 

func (o *ErrorDetail) HasIn() bool

HasIn returns a boolean if a field has been set.

func (*ErrorDetail) HasSubCategory 

func (o *ErrorDetail) HasSubCategory() bool

HasSubCategory returns a boolean if a field has been set.

func (ErrorDetail) MarshalJSON 

func (o ErrorDetail) MarshalJSON() ([]byte, error)

func (*ErrorDetail) SetCode 

func (o *ErrorDetail) SetCode(v string)

SetCode gets a reference to the given string and assigns it to the Code field.

func (*ErrorDetail) SetContext 

func (o *ErrorDetail) SetContext(v map[string][]string)

SetContext gets a reference to the given map[string][]string and assigns it to the Context field.

func (*ErrorDetail) SetIn 

func (o *ErrorDetail) SetIn(v string)

SetIn gets a reference to the given string and assigns it to the In field.

func (*ErrorDetail) SetMessage 

func (o *ErrorDetail) SetMessage(v string)

SetMessage sets field value

func (*ErrorDetail) SetSubCategory 

func (o *ErrorDetail) SetSubCategory(v string)

SetSubCategory gets a reference to the given string and assigns it to the SubCategory field.

type GenericOpenAPIError 

type GenericOpenAPIError struct {
	// contains filtered or unexported fields
}

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body 

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error 

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model 

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type NullableBool 

type NullableBool struct {
	// contains filtered or unexported fields
}

func NewNullableBool 

func NewNullableBool(val *bool) *NullableBool

func (NullableBool) Get 

func (v NullableBool) Get() *bool

func (NullableBool) IsSet 

func (v NullableBool) IsSet() bool

func (NullableBool) MarshalJSON 

func (v NullableBool) MarshalJSON() ([]byte, error)

func (*NullableBool) Set 

func (v *NullableBool) Set(val *bool)

func (*NullableBool) UnmarshalJSON 

func (v *NullableBool) UnmarshalJSON(src []byte) error

func (*NullableBool) Unset 

func (v *NullableBool) Unset()

type NullableError 

type NullableError struct {
	// contains filtered or unexported fields
}

func NewNullableError 

func NewNullableError(val *Error) *NullableError

func (NullableError) Get 

func (v NullableError) Get() *Error

func (NullableError) IsSet 

func (v NullableError) IsSet() bool

func (NullableError) MarshalJSON 

func (v NullableError) MarshalJSON() ([]byte, error)

func (*NullableError) Set 

func (v *NullableError) Set(val *Error)

func (*NullableError) UnmarshalJSON 

func (v *NullableError) UnmarshalJSON(src []byte) error

func (*NullableError) Unset 

func (v *NullableError) Unset()

type NullableErrorDetail 

type NullableErrorDetail struct {
	// contains filtered or unexported fields
}

func NewNullableErrorDetail 

func NewNullableErrorDetail(val *ErrorDetail) *NullableErrorDetail

func (NullableErrorDetail) Get 

func (v NullableErrorDetail) Get() *ErrorDetail

func (NullableErrorDetail) IsSet 

func (v NullableErrorDetail) IsSet() bool

func (NullableErrorDetail) MarshalJSON 

func (v NullableErrorDetail) MarshalJSON() ([]byte, error)

func (*NullableErrorDetail) Set 

func (v *NullableErrorDetail) Set(val *ErrorDetail)

func (*NullableErrorDetail) UnmarshalJSON 

func (v *NullableErrorDetail) UnmarshalJSON(src []byte) error

func (*NullableErrorDetail) Unset 

func (v *NullableErrorDetail) Unset()

type NullableFloat32 

type NullableFloat32 struct {
	// contains filtered or unexported fields
}

func NewNullableFloat32 

func NewNullableFloat32(val *float32) *NullableFloat32

func (NullableFloat32) Get 

func (v NullableFloat32) Get() *float32

func (NullableFloat32) IsSet 

func (v NullableFloat32) IsSet() bool

func (NullableFloat32) MarshalJSON 

func (v NullableFloat32) MarshalJSON() ([]byte, error)

func (*NullableFloat32) Set 

func (v *NullableFloat32) Set(val *float32)

func (*NullableFloat32) UnmarshalJSON 

func (v *NullableFloat32) UnmarshalJSON(src []byte) error

func (*NullableFloat32) Unset 

func (v *NullableFloat32) Unset()

type NullableFloat64 

type NullableFloat64 struct {
	// contains filtered or unexported fields
}

func NewNullableFloat64 

func NewNullableFloat64(val *float64) *NullableFloat64

func (NullableFloat64) Get 

func (v NullableFloat64) Get() *float64

func (NullableFloat64) IsSet 

func (v NullableFloat64) IsSet() bool

func (NullableFloat64) MarshalJSON 

func (v NullableFloat64) MarshalJSON() ([]byte, error)

func (*NullableFloat64) Set 

func (v *NullableFloat64) Set(val *float64)

func (*NullableFloat64) UnmarshalJSON 

func (v *NullableFloat64) UnmarshalJSON(src []byte) error

func (*NullableFloat64) Unset 

func (v *NullableFloat64) Unset()

type NullableInt 

type NullableInt struct {
	// contains filtered or unexported fields
}

func NewNullableInt 

func NewNullableInt(val *int) *NullableInt

func (NullableInt) Get 

func (v NullableInt) Get() *int

func (NullableInt) IsSet 

func (v NullableInt) IsSet() bool

func (NullableInt) MarshalJSON 

func (v NullableInt) MarshalJSON() ([]byte, error)

func (*NullableInt) Set 

func (v *NullableInt) Set(val *int)

func (*NullableInt) UnmarshalJSON 

func (v *NullableInt) UnmarshalJSON(src []byte) error

func (*NullableInt) Unset 

func (v *NullableInt) Unset()

type NullableInt32 

type NullableInt32 struct {
	// contains filtered or unexported fields
}

func NewNullableInt32 

func NewNullableInt32(val *int32) *NullableInt32

func (NullableInt32) Get 

func (v NullableInt32) Get() *int32

func (NullableInt32) IsSet 

func (v NullableInt32) IsSet() bool

func (NullableInt32) MarshalJSON 

func (v NullableInt32) MarshalJSON() ([]byte, error)

func (*NullableInt32) Set 

func (v *NullableInt32) Set(val *int32)

func (*NullableInt32) UnmarshalJSON 

func (v *NullableInt32) UnmarshalJSON(src []byte) error

func (*NullableInt32) Unset 

func (v *NullableInt32) Unset()

type NullableInt64 

type NullableInt64 struct {
	// contains filtered or unexported fields
}

func NewNullableInt64 

func NewNullableInt64(val *int64) *NullableInt64

func (NullableInt64) Get 

func (v NullableInt64) Get() *int64

func (NullableInt64) IsSet 

func (v NullableInt64) IsSet() bool

func (NullableInt64) MarshalJSON 

func (v NullableInt64) MarshalJSON() ([]byte, error)

func (*NullableInt64) Set 

func (v *NullableInt64) Set(val *int64)

func (*NullableInt64) UnmarshalJSON 

func (v *NullableInt64) UnmarshalJSON(src []byte) error

func (*NullableInt64) Unset 

func (v *NullableInt64) Unset()

type NullableRecordingSettingsPatchRequest 

type NullableRecordingSettingsPatchRequest struct {
	// contains filtered or unexported fields
}

func NewNullableRecordingSettingsPatchRequest 

func NewNullableRecordingSettingsPatchRequest(val *RecordingSettingsPatchRequest) *NullableRecordingSettingsPatchRequest

func (NullableRecordingSettingsPatchRequest) Get 

func (v NullableRecordingSettingsPatchRequest) Get() *RecordingSettingsPatchRequest

func (NullableRecordingSettingsPatchRequest) IsSet 

func (v NullableRecordingSettingsPatchRequest) IsSet() bool

func (NullableRecordingSettingsPatchRequest) MarshalJSON 

func (v NullableRecordingSettingsPatchRequest) MarshalJSON() ([]byte, error)

func (*NullableRecordingSettingsPatchRequest) Set 

func (v *NullableRecordingSettingsPatchRequest) Set(val *RecordingSettingsPatchRequest)

func (*NullableRecordingSettingsPatchRequest) UnmarshalJSON 

func (v *NullableRecordingSettingsPatchRequest) UnmarshalJSON(src []byte) error

func (*NullableRecordingSettingsPatchRequest) Unset 

func (v *NullableRecordingSettingsPatchRequest) Unset()

type NullableRecordingSettingsRequest 

type NullableRecordingSettingsRequest struct {
	// contains filtered or unexported fields
}

func NewNullableRecordingSettingsRequest 

func NewNullableRecordingSettingsRequest(val *RecordingSettingsRequest) *NullableRecordingSettingsRequest

func (NullableRecordingSettingsRequest) Get 

func (v NullableRecordingSettingsRequest) Get() *RecordingSettingsRequest

func (NullableRecordingSettingsRequest) IsSet 

func (v NullableRecordingSettingsRequest) IsSet() bool

func (NullableRecordingSettingsRequest) MarshalJSON 

func (v NullableRecordingSettingsRequest) MarshalJSON() ([]byte, error)

func (*NullableRecordingSettingsRequest) Set 

func (v *NullableRecordingSettingsRequest) Set(val *RecordingSettingsRequest)

func (*NullableRecordingSettingsRequest) UnmarshalJSON 

func (v *NullableRecordingSettingsRequest) UnmarshalJSON(src []byte) error

func (*NullableRecordingSettingsRequest) Unset 

func (v *NullableRecordingSettingsRequest) Unset()

type NullableRecordingSettingsResponse 

type NullableRecordingSettingsResponse struct {
	// contains filtered or unexported fields
}

func NewNullableRecordingSettingsResponse 

func NewNullableRecordingSettingsResponse(val *RecordingSettingsResponse) *NullableRecordingSettingsResponse

func (NullableRecordingSettingsResponse) Get 

func (v NullableRecordingSettingsResponse) Get() *RecordingSettingsResponse

func (NullableRecordingSettingsResponse) IsSet 

func (v NullableRecordingSettingsResponse) IsSet() bool

func (NullableRecordingSettingsResponse) MarshalJSON 

func (v NullableRecordingSettingsResponse) MarshalJSON() ([]byte, error)

func (*NullableRecordingSettingsResponse) Set 

func (v *NullableRecordingSettingsResponse) Set(val *RecordingSettingsResponse)

func (*NullableRecordingSettingsResponse) UnmarshalJSON 

func (v *NullableRecordingSettingsResponse) UnmarshalJSON(src []byte) error

func (*NullableRecordingSettingsResponse) Unset 

func (v *NullableRecordingSettingsResponse) Unset()

type NullableSettingsPatchRequest 

type NullableSettingsPatchRequest struct {
	// contains filtered or unexported fields
}

func NewNullableSettingsPatchRequest 

func NewNullableSettingsPatchRequest(val *SettingsPatchRequest) *NullableSettingsPatchRequest

func (NullableSettingsPatchRequest) Get 

func (v NullableSettingsPatchRequest) Get() *SettingsPatchRequest

func (NullableSettingsPatchRequest) IsSet 

func (v NullableSettingsPatchRequest) IsSet() bool

func (NullableSettingsPatchRequest) MarshalJSON 

func (v NullableSettingsPatchRequest) MarshalJSON() ([]byte, error)

func (*NullableSettingsPatchRequest) Set 

func (v *NullableSettingsPatchRequest) Set(val *SettingsPatchRequest)

func (*NullableSettingsPatchRequest) UnmarshalJSON 

func (v *NullableSettingsPatchRequest) UnmarshalJSON(src []byte) error

func (*NullableSettingsPatchRequest) Unset 

func (v *NullableSettingsPatchRequest) Unset()

type NullableSettingsRequest 

type NullableSettingsRequest struct {
	// contains filtered or unexported fields
}

func NewNullableSettingsRequest 

func NewNullableSettingsRequest(val *SettingsRequest) *NullableSettingsRequest

func (NullableSettingsRequest) Get 

func (v NullableSettingsRequest) Get() *SettingsRequest

func (NullableSettingsRequest) IsSet 

func (v NullableSettingsRequest) IsSet() bool

func (NullableSettingsRequest) MarshalJSON 

func (v NullableSettingsRequest) MarshalJSON() ([]byte, error)

func (*NullableSettingsRequest) Set 

func (v *NullableSettingsRequest) Set(val *SettingsRequest)

func (*NullableSettingsRequest) UnmarshalJSON 

func (v *NullableSettingsRequest) UnmarshalJSON(src []byte) error

func (*NullableSettingsRequest) Unset 

func (v *NullableSettingsRequest) Unset()

type NullableSettingsResponse 

type NullableSettingsResponse struct {
	// contains filtered or unexported fields
}

func NewNullableSettingsResponse 

func NewNullableSettingsResponse(val *SettingsResponse) *NullableSettingsResponse

func (NullableSettingsResponse) Get 

func (v NullableSettingsResponse) Get() *SettingsResponse

func (NullableSettingsResponse) IsSet 

func (v NullableSettingsResponse) IsSet() bool

func (NullableSettingsResponse) MarshalJSON 

func (v NullableSettingsResponse) MarshalJSON() ([]byte, error)

func (*NullableSettingsResponse) Set 

func (v *NullableSettingsResponse) Set(val *SettingsResponse)

func (*NullableSettingsResponse) UnmarshalJSON 

func (v *NullableSettingsResponse) UnmarshalJSON(src []byte) error

func (*NullableSettingsResponse) Unset 

func (v *NullableSettingsResponse) Unset()

type NullableString 

type NullableString struct {
	// contains filtered or unexported fields
}

func NewNullableString 

func NewNullableString(val *string) *NullableString

func (NullableString) Get 

func (v NullableString) Get() *string

func (NullableString) IsSet 

func (v NullableString) IsSet() bool

func (NullableString) MarshalJSON 

func (v NullableString) MarshalJSON() ([]byte, error)

func (*NullableString) Set 

func (v *NullableString) Set(val *string)

func (*NullableString) UnmarshalJSON 

func (v *NullableString) UnmarshalJSON(src []byte) error

func (*NullableString) Unset 

func (v *NullableString) Unset()

type NullableTime 

type NullableTime struct {
	// contains filtered or unexported fields
}

func NewNullableTime 

func NewNullableTime(val *time.Time) *NullableTime

func (NullableTime) Get 

func (v NullableTime) Get() *time.Time

func (NullableTime) IsSet 

func (v NullableTime) IsSet() bool

func (NullableTime) MarshalJSON 

func (v NullableTime) MarshalJSON() ([]byte, error)

func (*NullableTime) Set 

func (v *NullableTime) Set(val *time.Time)

func (*NullableTime) UnmarshalJSON 

func (v *NullableTime) UnmarshalJSON(src []byte) error

func (*NullableTime) Unset 

func (v *NullableTime) Unset()

type RecordingSettingsApiService 

type RecordingSettingsApiService service

RecordingSettingsApiService RecordingSettingsApi service

func (*RecordingSettingsApiService) GetCrmV3ExtensionsCallingAppIdSettingsRecordingGetUrlFormat 

func (a *RecordingSettingsApiService) GetCrmV3ExtensionsCallingAppIdSettingsRecordingGetUrlFormat(ctx context.Context, appId int32) ApiGetCrmV3ExtensionsCallingAppIdSettingsRecordingGetUrlFormatRequest

GetCrmV3ExtensionsCallingAppIdSettingsRecordingGetUrlFormat Method for GetCrmV3ExtensionsCallingAppIdSettingsRecordingGetUrlFormat 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param appId
@return ApiGetCrmV3ExtensionsCallingAppIdSettingsRecordingGetUrlFormatRequest

func (*RecordingSettingsApiService) GetCrmV3ExtensionsCallingAppIdSettingsRecordingGetUrlFormatExecute 

func (a *RecordingSettingsApiService) GetCrmV3ExtensionsCallingAppIdSettingsRecordingGetUrlFormatExecute(r ApiGetCrmV3ExtensionsCallingAppIdSettingsRecordingGetUrlFormatRequest) (*RecordingSettingsResponse, *http.Response, error)

Execute executes the request 

@return RecordingSettingsResponse

func (*RecordingSettingsApiService) PatchCrmV3ExtensionsCallingAppIdSettingsRecordingUpdateUrlFormat 

func (a *RecordingSettingsApiService) PatchCrmV3ExtensionsCallingAppIdSettingsRecordingUpdateUrlFormat(ctx context.Context, appId int32) ApiPatchCrmV3ExtensionsCallingAppIdSettingsRecordingUpdateUrlFormatRequest

PatchCrmV3ExtensionsCallingAppIdSettingsRecordingUpdateUrlFormat Method for PatchCrmV3ExtensionsCallingAppIdSettingsRecordingUpdateUrlFormat 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param appId
@return ApiPatchCrmV3ExtensionsCallingAppIdSettingsRecordingUpdateUrlFormatRequest

func (*RecordingSettingsApiService) PatchCrmV3ExtensionsCallingAppIdSettingsRecordingUpdateUrlFormatExecute 

func (a *RecordingSettingsApiService) PatchCrmV3ExtensionsCallingAppIdSettingsRecordingUpdateUrlFormatExecute(r ApiPatchCrmV3ExtensionsCallingAppIdSettingsRecordingUpdateUrlFormatRequest) (*RecordingSettingsResponse, *http.Response, error)

Execute executes the request 

@return RecordingSettingsResponse

func (*RecordingSettingsApiService) PostCrmV3ExtensionsCallingAppIdSettingsRecordingRegisterUrlFormat 

func (a *RecordingSettingsApiService) PostCrmV3ExtensionsCallingAppIdSettingsRecordingRegisterUrlFormat(ctx context.Context, appId int32) ApiPostCrmV3ExtensionsCallingAppIdSettingsRecordingRegisterUrlFormatRequest

PostCrmV3ExtensionsCallingAppIdSettingsRecordingRegisterUrlFormat Method for PostCrmV3ExtensionsCallingAppIdSettingsRecordingRegisterUrlFormat 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param appId
@return ApiPostCrmV3ExtensionsCallingAppIdSettingsRecordingRegisterUrlFormatRequest

func (*RecordingSettingsApiService) PostCrmV3ExtensionsCallingAppIdSettingsRecordingRegisterUrlFormatExecute 

func (a *RecordingSettingsApiService) PostCrmV3ExtensionsCallingAppIdSettingsRecordingRegisterUrlFormatExecute(r ApiPostCrmV3ExtensionsCallingAppIdSettingsRecordingRegisterUrlFormatRequest) (*RecordingSettingsResponse, *http.Response, error)

Execute executes the request 

@return RecordingSettingsResponse

type RecordingSettingsPatchRequest 

type RecordingSettingsPatchRequest struct {
	UrlToRetrieveAuthedRecording *string `json:"urlToRetrieveAuthedRecording,omitempty"`
}

RecordingSettingsPatchRequest struct for RecordingSettingsPatchRequest

func NewRecordingSettingsPatchRequest 

func NewRecordingSettingsPatchRequest() *RecordingSettingsPatchRequest

NewRecordingSettingsPatchRequest instantiates a new RecordingSettingsPatchRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewRecordingSettingsPatchRequestWithDefaults 

func NewRecordingSettingsPatchRequestWithDefaults() *RecordingSettingsPatchRequest

NewRecordingSettingsPatchRequestWithDefaults instantiates a new RecordingSettingsPatchRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*RecordingSettingsPatchRequest) GetUrlToRetrieveAuthedRecording 

func (o *RecordingSettingsPatchRequest) GetUrlToRetrieveAuthedRecording() string

GetUrlToRetrieveAuthedRecording returns the UrlToRetrieveAuthedRecording field value if set, zero value otherwise.

func (*RecordingSettingsPatchRequest) GetUrlToRetrieveAuthedRecordingOk 

func (o *RecordingSettingsPatchRequest) GetUrlToRetrieveAuthedRecordingOk() (*string, bool)

GetUrlToRetrieveAuthedRecordingOk returns a tuple with the UrlToRetrieveAuthedRecording field value if set, nil otherwise and a boolean to check if the value has been set.

func (*RecordingSettingsPatchRequest) HasUrlToRetrieveAuthedRecording 

func (o *RecordingSettingsPatchRequest) HasUrlToRetrieveAuthedRecording() bool

HasUrlToRetrieveAuthedRecording returns a boolean if a field has been set.

func (RecordingSettingsPatchRequest) MarshalJSON 

func (o RecordingSettingsPatchRequest) MarshalJSON() ([]byte, error)

func (*RecordingSettingsPatchRequest) SetUrlToRetrieveAuthedRecording 

func (o *RecordingSettingsPatchRequest) SetUrlToRetrieveAuthedRecording(v string)

SetUrlToRetrieveAuthedRecording gets a reference to the given string and assigns it to the UrlToRetrieveAuthedRecording field.

type RecordingSettingsRequest 

type RecordingSettingsRequest struct {
	UrlToRetrieveAuthedRecording string `json:"urlToRetrieveAuthedRecording"`
}

RecordingSettingsRequest struct for RecordingSettingsRequest

func NewRecordingSettingsRequest 

func NewRecordingSettingsRequest(urlToRetrieveAuthedRecording string) *RecordingSettingsRequest

NewRecordingSettingsRequest instantiates a new RecordingSettingsRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewRecordingSettingsRequestWithDefaults 

func NewRecordingSettingsRequestWithDefaults() *RecordingSettingsRequest

NewRecordingSettingsRequestWithDefaults instantiates a new RecordingSettingsRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*RecordingSettingsRequest) GetUrlToRetrieveAuthedRecording 

func (o *RecordingSettingsRequest) GetUrlToRetrieveAuthedRecording() string

GetUrlToRetrieveAuthedRecording returns the UrlToRetrieveAuthedRecording field value

func (*RecordingSettingsRequest) GetUrlToRetrieveAuthedRecordingOk 

func (o *RecordingSettingsRequest) GetUrlToRetrieveAuthedRecordingOk() (*string, bool)

GetUrlToRetrieveAuthedRecordingOk returns a tuple with the UrlToRetrieveAuthedRecording field value and a boolean to check if the value has been set.

func (RecordingSettingsRequest) MarshalJSON 

func (o RecordingSettingsRequest) MarshalJSON() ([]byte, error)

func (*RecordingSettingsRequest) SetUrlToRetrieveAuthedRecording 

func (o *RecordingSettingsRequest) SetUrlToRetrieveAuthedRecording(v string)

SetUrlToRetrieveAuthedRecording sets field value

type RecordingSettingsResponse 

type RecordingSettingsResponse struct {
	UrlToRetrieveAuthedRecording string `json:"urlToRetrieveAuthedRecording"`
}

RecordingSettingsResponse struct for RecordingSettingsResponse

func NewRecordingSettingsResponse 

func NewRecordingSettingsResponse(urlToRetrieveAuthedRecording string) *RecordingSettingsResponse

NewRecordingSettingsResponse instantiates a new RecordingSettingsResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewRecordingSettingsResponseWithDefaults 

func NewRecordingSettingsResponseWithDefaults() *RecordingSettingsResponse

NewRecordingSettingsResponseWithDefaults instantiates a new RecordingSettingsResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*RecordingSettingsResponse) GetUrlToRetrieveAuthedRecording 

func (o *RecordingSettingsResponse) GetUrlToRetrieveAuthedRecording() string

GetUrlToRetrieveAuthedRecording returns the UrlToRetrieveAuthedRecording field value

func (*RecordingSettingsResponse) GetUrlToRetrieveAuthedRecordingOk 

func (o *RecordingSettingsResponse) GetUrlToRetrieveAuthedRecordingOk() (*string, bool)

GetUrlToRetrieveAuthedRecordingOk returns a tuple with the UrlToRetrieveAuthedRecording field value and a boolean to check if the value has been set.

func (RecordingSettingsResponse) MarshalJSON 

func (o RecordingSettingsResponse) MarshalJSON() ([]byte, error)

func (*RecordingSettingsResponse) SetUrlToRetrieveAuthedRecording 

func (o *RecordingSettingsResponse) SetUrlToRetrieveAuthedRecording(v string)

SetUrlToRetrieveAuthedRecording sets field value

type ServerConfiguration 

type ServerConfiguration struct {
	URL         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerConfigurations 

type ServerConfigurations []ServerConfiguration

ServerConfigurations stores multiple ServerConfiguration items

func (ServerConfigurations) URL 

func (sc ServerConfigurations) URL(index int, variables map[string]string) (string, error)

URL formats template on a index using given variables

type ServerVariable 

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

type SettingsApiService 

type SettingsApiService service

SettingsApiService SettingsApi service

func (*SettingsApiService) Archive 

func (a *SettingsApiService) Archive(ctx context.Context, appId int32) ApiArchiveRequest

Archive Delete calling settings

Deletes this calling extension. This will remove your service as an option for all connected accounts. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param appId The ID of the target app.
@return ApiArchiveRequest

func (*SettingsApiService) ArchiveExecute 

func (a *SettingsApiService) ArchiveExecute(r ApiArchiveRequest) (*http.Response, error)

Execute executes the request

func (*SettingsApiService) Create 

func (a *SettingsApiService) Create(ctx context.Context, appId int32) ApiCreateRequest

Create Configure a calling extension

Used to set the menu label, target iframe URL, and dimensions for your calling extension. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param appId The ID of the target app.
@return ApiCreateRequest

func (*SettingsApiService) CreateExecute 

func (a *SettingsApiService) CreateExecute(r ApiCreateRequest) (*SettingsResponse, *http.Response, error)

Execute executes the request 

@return SettingsResponse

func (*SettingsApiService) GetByID 

func (a *SettingsApiService) GetByID(ctx context.Context, appId int32) ApiGetByIDRequest

GetByID Get calling settings

Returns the calling extension settings configured for your app. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param appId The ID of the target app.
@return ApiGetByIDRequest

func (*SettingsApiService) GetByIDExecute 

func (a *SettingsApiService) GetByIDExecute(r ApiGetByIDRequest) (*SettingsResponse, *http.Response, error)

Execute executes the request 

@return SettingsResponse

func (*SettingsApiService) Update 

func (a *SettingsApiService) Update(ctx context.Context, appId int32) ApiUpdateRequest

Update Update settings

Updates existing calling extension settings. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param appId The ID of the target app.
@return ApiUpdateRequest

func (*SettingsApiService) UpdateExecute 

func (a *SettingsApiService) UpdateExecute(r ApiUpdateRequest) (*SettingsResponse, *http.Response, error)

Execute executes the request 

@return SettingsResponse

type SettingsPatchRequest 

type SettingsPatchRequest struct {
	// 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"`
	// 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"`
	// The target width of the iframe that will contain your phone/calling UI.
	Width *int32 `json:"width,omitempty"`
	// The URL to your phone/calling UI, built with the [Calling SDK](#).
	Url *string `json:"url,omitempty"`
	// The target height of the iframe that will contain your phone/calling UI.
	Height *int32 `json:"height,omitempty"`
}

SettingsPatchRequest Settings update request

func NewSettingsPatchRequest 

func NewSettingsPatchRequest() *SettingsPatchRequest

NewSettingsPatchRequest instantiates a new SettingsPatchRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewSettingsPatchRequestWithDefaults 

func NewSettingsPatchRequestWithDefaults() *SettingsPatchRequest

NewSettingsPatchRequestWithDefaults instantiates a new SettingsPatchRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*SettingsPatchRequest) GetHeight 

func (o *SettingsPatchRequest) GetHeight() int32

GetHeight returns the Height field value if set, zero value otherwise.

func (*SettingsPatchRequest) GetHeightOk 

func (o *SettingsPatchRequest) GetHeightOk() (*int32, bool)

GetHeightOk returns a tuple with the Height field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SettingsPatchRequest) GetIsReady 

func (o *SettingsPatchRequest) GetIsReady() bool

GetIsReady returns the IsReady field value if set, zero value otherwise.

func (*SettingsPatchRequest) GetIsReadyOk 

func (o *SettingsPatchRequest) GetIsReadyOk() (*bool, bool)

GetIsReadyOk returns a tuple with the IsReady field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SettingsPatchRequest) GetName 

func (o *SettingsPatchRequest) GetName() string

GetName returns the Name field value if set, zero value otherwise.

func (*SettingsPatchRequest) GetNameOk 

func (o *SettingsPatchRequest) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SettingsPatchRequest) GetSupportsCustomObjects 

func (o *SettingsPatchRequest) GetSupportsCustomObjects() bool

GetSupportsCustomObjects returns the SupportsCustomObjects field value if set, zero value otherwise.

func (*SettingsPatchRequest) GetSupportsCustomObjectsOk 

func (o *SettingsPatchRequest) GetSupportsCustomObjectsOk() (*bool, bool)

GetSupportsCustomObjectsOk returns a tuple with the SupportsCustomObjects field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SettingsPatchRequest) GetUrl 

func (o *SettingsPatchRequest) GetUrl() string

GetUrl returns the Url field value if set, zero value otherwise.

func (*SettingsPatchRequest) GetUrlOk 

func (o *SettingsPatchRequest) GetUrlOk() (*string, bool)

GetUrlOk returns a tuple with the Url field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SettingsPatchRequest) GetWidth 

func (o *SettingsPatchRequest) GetWidth() int32

GetWidth returns the Width field value if set, zero value otherwise.

func (*SettingsPatchRequest) GetWidthOk 

func (o *SettingsPatchRequest) GetWidthOk() (*int32, bool)

GetWidthOk returns a tuple with the Width field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SettingsPatchRequest) HasHeight 

func (o *SettingsPatchRequest) HasHeight() bool

HasHeight returns a boolean if a field has been set.

func (*SettingsPatchRequest) HasIsReady 

func (o *SettingsPatchRequest) HasIsReady() bool

HasIsReady returns a boolean if a field has been set.

func (*SettingsPatchRequest) HasName 

func (o *SettingsPatchRequest) HasName() bool

HasName returns a boolean if a field has been set.

func (*SettingsPatchRequest) HasSupportsCustomObjects 

func (o *SettingsPatchRequest) HasSupportsCustomObjects() bool

HasSupportsCustomObjects returns a boolean if a field has been set.

func (*SettingsPatchRequest) HasUrl 

func (o *SettingsPatchRequest) HasUrl() bool

HasUrl returns a boolean if a field has been set.

func (*SettingsPatchRequest) HasWidth 

func (o *SettingsPatchRequest) HasWidth() bool

HasWidth returns a boolean if a field has been set.

func (SettingsPatchRequest) MarshalJSON 

func (o SettingsPatchRequest) MarshalJSON() ([]byte, error)

func (*SettingsPatchRequest) SetHeight 

func (o *SettingsPatchRequest) SetHeight(v int32)

SetHeight gets a reference to the given int32 and assigns it to the Height field.

func (*SettingsPatchRequest) SetIsReady 

func (o *SettingsPatchRequest) SetIsReady(v bool)

SetIsReady gets a reference to the given bool and assigns it to the IsReady field.

func (*SettingsPatchRequest) SetName 

func (o *SettingsPatchRequest) SetName(v string)

SetName gets a reference to the given string and assigns it to the Name field.

func (*SettingsPatchRequest) SetSupportsCustomObjects 

func (o *SettingsPatchRequest) SetSupportsCustomObjects(v bool)

SetSupportsCustomObjects gets a reference to the given bool and assigns it to the SupportsCustomObjects field.

func (*SettingsPatchRequest) SetUrl 

func (o *SettingsPatchRequest) SetUrl(v string)

SetUrl gets a reference to the given string and assigns it to the Url field.

func (*SettingsPatchRequest) SetWidth 

func (o *SettingsPatchRequest) SetWidth(v int32)

SetWidth gets a reference to the given int32 and assigns it to the Width field.

type SettingsRequest 

type SettingsRequest struct {
	// 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"`
	// 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"`
	// The target width of the iframe that will contain your phone/calling UI.
	Width *int32 `json:"width,omitempty"`
	// The URL to your phone/calling UI, built with the [Calling SDK](#).
	Url string `json:"url"`
	// The target height of the iframe that will contain your phone/calling UI.
	Height *int32 `json:"height,omitempty"`
}

SettingsRequest Settings create request

func NewSettingsRequest 

func NewSettingsRequest(name string, url string) *SettingsRequest

NewSettingsRequest instantiates a new SettingsRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewSettingsRequestWithDefaults 

func NewSettingsRequestWithDefaults() *SettingsRequest

NewSettingsRequestWithDefaults instantiates a new SettingsRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*SettingsRequest) GetHeight 

func (o *SettingsRequest) GetHeight() int32

GetHeight returns the Height field value if set, zero value otherwise.

func (*SettingsRequest) GetHeightOk 

func (o *SettingsRequest) GetHeightOk() (*int32, bool)

GetHeightOk returns a tuple with the Height field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SettingsRequest) GetIsReady 

func (o *SettingsRequest) GetIsReady() bool

GetIsReady returns the IsReady field value if set, zero value otherwise.

func (*SettingsRequest) GetIsReadyOk 

func (o *SettingsRequest) GetIsReadyOk() (*bool, bool)

GetIsReadyOk returns a tuple with the IsReady field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SettingsRequest) GetName 

func (o *SettingsRequest) GetName() string

GetName returns the Name field value

func (*SettingsRequest) GetNameOk 

func (o *SettingsRequest) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value and a boolean to check if the value has been set.

func (*SettingsRequest) GetSupportsCustomObjects 

func (o *SettingsRequest) GetSupportsCustomObjects() bool

GetSupportsCustomObjects returns the SupportsCustomObjects field value if set, zero value otherwise.

func (*SettingsRequest) GetSupportsCustomObjectsOk 

func (o *SettingsRequest) GetSupportsCustomObjectsOk() (*bool, bool)

GetSupportsCustomObjectsOk returns a tuple with the SupportsCustomObjects field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SettingsRequest) GetUrl 

func (o *SettingsRequest) GetUrl() string

GetUrl returns the Url field value

func (*SettingsRequest) GetUrlOk 

func (o *SettingsRequest) GetUrlOk() (*string, bool)

GetUrlOk returns a tuple with the Url field value and a boolean to check if the value has been set.

func (*SettingsRequest) GetWidth 

func (o *SettingsRequest) GetWidth() int32

GetWidth returns the Width field value if set, zero value otherwise.

func (*SettingsRequest) GetWidthOk 

func (o *SettingsRequest) GetWidthOk() (*int32, bool)

GetWidthOk returns a tuple with the Width field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SettingsRequest) HasHeight 

func (o *SettingsRequest) HasHeight() bool

HasHeight returns a boolean if a field has been set.

func (*SettingsRequest) HasIsReady 

func (o *SettingsRequest) HasIsReady() bool

HasIsReady returns a boolean if a field has been set.

func (*SettingsRequest) HasSupportsCustomObjects 

func (o *SettingsRequest) HasSupportsCustomObjects() bool

HasSupportsCustomObjects returns a boolean if a field has been set.

func (*SettingsRequest) HasWidth 

func (o *SettingsRequest) HasWidth() bool

HasWidth returns a boolean if a field has been set.

func (SettingsRequest) MarshalJSON 

func (o SettingsRequest) MarshalJSON() ([]byte, error)

func (*SettingsRequest) SetHeight 

func (o *SettingsRequest) SetHeight(v int32)

SetHeight gets a reference to the given int32 and assigns it to the Height field.

func (*SettingsRequest) SetIsReady 

func (o *SettingsRequest) SetIsReady(v bool)

SetIsReady gets a reference to the given bool and assigns it to the IsReady field.

func (*SettingsRequest) SetName 

func (o *SettingsRequest) SetName(v string)

SetName sets field value

func (*SettingsRequest) SetSupportsCustomObjects 

func (o *SettingsRequest) SetSupportsCustomObjects(v bool)

SetSupportsCustomObjects gets a reference to the given bool and assigns it to the SupportsCustomObjects field.

func (*SettingsRequest) SetUrl 

func (o *SettingsRequest) SetUrl(v string)

SetUrl sets field value

func (*SettingsRequest) SetWidth 

func (o *SettingsRequest) SetWidth(v int32)

SetWidth gets a reference to the given int32 and assigns it to the Width field.

type SettingsResponse 

type SettingsResponse struct {
	// When this calling extension was created.
	CreatedAt time.Time `json:"createdAt"`
	// 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"`
	// 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"`
	// The target width of the iframe that will contain your phone/calling UI.
	Width int32 `json:"width"`
	// The URL to your phone/calling UI, built with the [Calling SDK](#).
	Url string `json:"url"`
	// The target height of the iframe that will contain your phone/calling UI.
	Height int32 `json:"height"`
	// The last time the settings for this calling extension were modified.
	UpdatedAt time.Time `json:"updatedAt"`
}

SettingsResponse Current settings state

func NewSettingsResponse 

func NewSettingsResponse(createdAt time.Time, supportsCustomObjects bool, isReady bool, name string, width int32, url string, height int32, updatedAt time.Time) *SettingsResponse

NewSettingsResponse instantiates a new SettingsResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewSettingsResponseWithDefaults 

func NewSettingsResponseWithDefaults() *SettingsResponse

NewSettingsResponseWithDefaults instantiates a new SettingsResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*SettingsResponse) GetCreatedAt 

func (o *SettingsResponse) GetCreatedAt() time.Time

GetCreatedAt returns the CreatedAt field value

func (*SettingsResponse) GetCreatedAtOk 

func (o *SettingsResponse) GetCreatedAtOk() (*time.Time, bool)

GetCreatedAtOk returns a tuple with the CreatedAt field value and a boolean to check if the value has been set.

func (*SettingsResponse) GetHeight 

func (o *SettingsResponse) GetHeight() int32

GetHeight returns the Height field value

func (*SettingsResponse) GetHeightOk 

func (o *SettingsResponse) GetHeightOk() (*int32, bool)

GetHeightOk returns a tuple with the Height field value and a boolean to check if the value has been set.

func (*SettingsResponse) GetIsReady 

func (o *SettingsResponse) GetIsReady() bool

GetIsReady returns the IsReady field value

func (*SettingsResponse) GetIsReadyOk 

func (o *SettingsResponse) GetIsReadyOk() (*bool, bool)

GetIsReadyOk returns a tuple with the IsReady field value and a boolean to check if the value has been set.

func (*SettingsResponse) GetName 

func (o *SettingsResponse) GetName() string

GetName returns the Name field value

func (*SettingsResponse) GetNameOk 

func (o *SettingsResponse) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value and a boolean to check if the value has been set.

func (*SettingsResponse) GetSupportsCustomObjects 

func (o *SettingsResponse) GetSupportsCustomObjects() bool

GetSupportsCustomObjects returns the SupportsCustomObjects field value

func (*SettingsResponse) GetSupportsCustomObjectsOk 

func (o *SettingsResponse) GetSupportsCustomObjectsOk() (*bool, bool)

GetSupportsCustomObjectsOk returns a tuple with the SupportsCustomObjects field value and a boolean to check if the value has been set.

func (*SettingsResponse) GetUpdatedAt 

func (o *SettingsResponse) GetUpdatedAt() time.Time

GetUpdatedAt returns the UpdatedAt field value

func (*SettingsResponse) GetUpdatedAtOk 

func (o *SettingsResponse) GetUpdatedAtOk() (*time.Time, bool)

GetUpdatedAtOk returns a tuple with the UpdatedAt field value and a boolean to check if the value has been set.

func (*SettingsResponse) GetUrl 

func (o *SettingsResponse) GetUrl() string

GetUrl returns the Url field value

func (*SettingsResponse) GetUrlOk 

func (o *SettingsResponse) GetUrlOk() (*string, bool)

GetUrlOk returns a tuple with the Url field value and a boolean to check if the value has been set.

func (*SettingsResponse) GetWidth 

func (o *SettingsResponse) GetWidth() int32

GetWidth returns the Width field value

func (*SettingsResponse) GetWidthOk 

func (o *SettingsResponse) GetWidthOk() (*int32, bool)

GetWidthOk returns a tuple with the Width field value and a boolean to check if the value has been set.

func (SettingsResponse) MarshalJSON 

func (o SettingsResponse) MarshalJSON() ([]byte, error)

func (*SettingsResponse) SetCreatedAt 

func (o *SettingsResponse) SetCreatedAt(v time.Time)

SetCreatedAt sets field value

func (*SettingsResponse) SetHeight 

func (o *SettingsResponse) SetHeight(v int32)

SetHeight sets field value

func (*SettingsResponse) SetIsReady 

func (o *SettingsResponse) SetIsReady(v bool)

SetIsReady sets field value

func (*SettingsResponse) SetName 

func (o *SettingsResponse) SetName(v string)

SetName sets field value

func (*SettingsResponse) SetSupportsCustomObjects 

func (o *SettingsResponse) SetSupportsCustomObjects(v bool)

SetSupportsCustomObjects sets field value

func (*SettingsResponse) SetUpdatedAt 

func (o *SettingsResponse) SetUpdatedAt(v time.Time)

SetUpdatedAt sets field value

func (*SettingsResponse) SetUrl 

func (o *SettingsResponse) SetUrl(v string)

SetUrl sets field value

func (*SettingsResponse) SetWidth 

func (o *SettingsResponse) SetWidth(v int32)

SetWidth sets field value

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.