webhooks

package
v2.0.1 Latest Latest
Warning

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

Go to latest
Published: Nov 7, 2022 License: MIT Imports: 22 Imported by: 0

README

Go API client for webhooks

Provides a way for apps to subscribe to certain change events in HubSpot. Once configured, apps will receive event payloads containing details about the changes at a specified target URL. There can only be one target URL for receiving event notifications per app.

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 webhooks "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(), webhooks.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(), webhooks.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(), webhooks.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), webhooks.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
SettingsApi SettingsClear Delete /webhooks/v3/{appId}/settings
SettingsApi SettingsConfigure Put /webhooks/v3/{appId}/settings
SettingsApi SettingsGetAll Get /webhooks/v3/{appId}/settings
SubscriptionsApi SubscriptionsArchive Delete /webhooks/v3/{appId}/subscriptions/{subscriptionId}
SubscriptionsApi SubscriptionsBatchUpdate Post /webhooks/v3/{appId}/subscriptions/batch/update
SubscriptionsApi SubscriptionsCreate Post /webhooks/v3/{appId}/subscriptions
SubscriptionsApi SubscriptionsGetAll Get /webhooks/v3/{appId}/subscriptions
SubscriptionsApi SubscriptionsGetByID Get /webhooks/v3/{appId}/subscriptions/{subscriptionId}
SubscriptionsApi SubscriptionsUpdate Patch /webhooks/v3/{appId}/subscriptions/{subscriptionId}

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 {
	SettingsApi *SettingsApiService

	SubscriptionsApi *SubscriptionsApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Webhooks API 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 ApiSettingsClearRequest

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

func (ApiSettingsClearRequest) Execute

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

type ApiSettingsConfigureRequest

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

func (ApiSettingsConfigureRequest) Execute

func (ApiSettingsConfigureRequest) SettingsChangeRequest

func (r ApiSettingsConfigureRequest) SettingsChangeRequest(settingsChangeRequest SettingsChangeRequest) ApiSettingsConfigureRequest

type ApiSettingsGetAllRequest

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

func (ApiSettingsGetAllRequest) Execute

type ApiSubscriptionsArchiveRequest

type ApiSubscriptionsArchiveRequest struct {
	ApiService *SubscriptionsApiService
	// contains filtered or unexported fields
}

func (ApiSubscriptionsArchiveRequest) Execute

type ApiSubscriptionsBatchUpdateRequest

type ApiSubscriptionsBatchUpdateRequest struct {
	ApiService *SubscriptionsApiService
	// contains filtered or unexported fields
}

func (ApiSubscriptionsBatchUpdateRequest) BatchInputSubscriptionBatchUpdateRequest

func (r ApiSubscriptionsBatchUpdateRequest) BatchInputSubscriptionBatchUpdateRequest(batchInputSubscriptionBatchUpdateRequest BatchInputSubscriptionBatchUpdateRequest) ApiSubscriptionsBatchUpdateRequest

func (ApiSubscriptionsBatchUpdateRequest) Execute

type ApiSubscriptionsCreateRequest

type ApiSubscriptionsCreateRequest struct {
	ApiService *SubscriptionsApiService
	// contains filtered or unexported fields
}

func (ApiSubscriptionsCreateRequest) Execute

func (ApiSubscriptionsCreateRequest) SubscriptionCreateRequest

func (r ApiSubscriptionsCreateRequest) SubscriptionCreateRequest(subscriptionCreateRequest SubscriptionCreateRequest) ApiSubscriptionsCreateRequest

type ApiSubscriptionsGetAllRequest

type ApiSubscriptionsGetAllRequest struct {
	ApiService *SubscriptionsApiService
	// contains filtered or unexported fields
}

func (ApiSubscriptionsGetAllRequest) Execute

type ApiSubscriptionsGetByIDRequest

type ApiSubscriptionsGetByIDRequest struct {
	ApiService *SubscriptionsApiService
	// contains filtered or unexported fields
}

func (ApiSubscriptionsGetByIDRequest) Execute

type ApiSubscriptionsUpdateRequest

type ApiSubscriptionsUpdateRequest struct {
	ApiService *SubscriptionsApiService
	// contains filtered or unexported fields
}

func (ApiSubscriptionsUpdateRequest) Execute

func (ApiSubscriptionsUpdateRequest) SubscriptionPatchRequest

func (r ApiSubscriptionsUpdateRequest) SubscriptionPatchRequest(subscriptionPatchRequest SubscriptionPatchRequest) ApiSubscriptionsUpdateRequest

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 BatchInputSubscriptionBatchUpdateRequest

type BatchInputSubscriptionBatchUpdateRequest struct {
	Inputs []SubscriptionBatchUpdateRequest `json:"inputs"`
}

BatchInputSubscriptionBatchUpdateRequest struct for BatchInputSubscriptionBatchUpdateRequest

func NewBatchInputSubscriptionBatchUpdateRequest

func NewBatchInputSubscriptionBatchUpdateRequest(inputs []SubscriptionBatchUpdateRequest) *BatchInputSubscriptionBatchUpdateRequest

NewBatchInputSubscriptionBatchUpdateRequest instantiates a new BatchInputSubscriptionBatchUpdateRequest 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 NewBatchInputSubscriptionBatchUpdateRequestWithDefaults

func NewBatchInputSubscriptionBatchUpdateRequestWithDefaults() *BatchInputSubscriptionBatchUpdateRequest

NewBatchInputSubscriptionBatchUpdateRequestWithDefaults instantiates a new BatchInputSubscriptionBatchUpdateRequest 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 (*BatchInputSubscriptionBatchUpdateRequest) GetInputs

GetInputs returns the Inputs field value

func (*BatchInputSubscriptionBatchUpdateRequest) GetInputsOk

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

func (BatchInputSubscriptionBatchUpdateRequest) MarshalJSON

func (*BatchInputSubscriptionBatchUpdateRequest) SetInputs

SetInputs sets field value

type BatchResponseSubscriptionResponse

type BatchResponseSubscriptionResponse struct {
	Status      string                 `json:"status"`
	Results     []SubscriptionResponse `json:"results"`
	RequestedAt *time.Time             `json:"requestedAt,omitempty"`
	StartedAt   time.Time              `json:"startedAt"`
	CompletedAt time.Time              `json:"completedAt"`
	Links       *map[string]string     `json:"links,omitempty"`
}

BatchResponseSubscriptionResponse struct for BatchResponseSubscriptionResponse

func NewBatchResponseSubscriptionResponse

func NewBatchResponseSubscriptionResponse(status string, results []SubscriptionResponse, startedAt time.Time, completedAt time.Time) *BatchResponseSubscriptionResponse

NewBatchResponseSubscriptionResponse instantiates a new BatchResponseSubscriptionResponse 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 NewBatchResponseSubscriptionResponseWithDefaults

func NewBatchResponseSubscriptionResponseWithDefaults() *BatchResponseSubscriptionResponse

NewBatchResponseSubscriptionResponseWithDefaults instantiates a new BatchResponseSubscriptionResponse 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 (*BatchResponseSubscriptionResponse) GetCompletedAt

func (o *BatchResponseSubscriptionResponse) GetCompletedAt() time.Time

GetCompletedAt returns the CompletedAt field value

func (*BatchResponseSubscriptionResponse) GetCompletedAtOk

func (o *BatchResponseSubscriptionResponse) GetCompletedAtOk() (*time.Time, bool)

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

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

func (*BatchResponseSubscriptionResponse) GetLinksOk

func (o *BatchResponseSubscriptionResponse) 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 (*BatchResponseSubscriptionResponse) GetRequestedAt

func (o *BatchResponseSubscriptionResponse) GetRequestedAt() time.Time

GetRequestedAt returns the RequestedAt field value if set, zero value otherwise.

func (*BatchResponseSubscriptionResponse) GetRequestedAtOk

func (o *BatchResponseSubscriptionResponse) GetRequestedAtOk() (*time.Time, bool)

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

func (*BatchResponseSubscriptionResponse) GetResults

GetResults returns the Results field value

func (*BatchResponseSubscriptionResponse) GetResultsOk

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

func (*BatchResponseSubscriptionResponse) GetStartedAt

func (o *BatchResponseSubscriptionResponse) GetStartedAt() time.Time

GetStartedAt returns the StartedAt field value

func (*BatchResponseSubscriptionResponse) GetStartedAtOk

func (o *BatchResponseSubscriptionResponse) GetStartedAtOk() (*time.Time, bool)

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

func (*BatchResponseSubscriptionResponse) GetStatus

GetStatus returns the Status field value

func (*BatchResponseSubscriptionResponse) GetStatusOk

func (o *BatchResponseSubscriptionResponse) GetStatusOk() (*string, bool)

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

HasLinks returns a boolean if a field has been set.

func (*BatchResponseSubscriptionResponse) HasRequestedAt

func (o *BatchResponseSubscriptionResponse) HasRequestedAt() bool

HasRequestedAt returns a boolean if a field has been set.

func (BatchResponseSubscriptionResponse) MarshalJSON

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

func (*BatchResponseSubscriptionResponse) SetCompletedAt

func (o *BatchResponseSubscriptionResponse) SetCompletedAt(v time.Time)

SetCompletedAt sets field value

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

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

func (*BatchResponseSubscriptionResponse) SetRequestedAt

func (o *BatchResponseSubscriptionResponse) SetRequestedAt(v time.Time)

SetRequestedAt gets a reference to the given time.Time and assigns it to the RequestedAt field.

func (*BatchResponseSubscriptionResponse) SetResults

SetResults sets field value

func (*BatchResponseSubscriptionResponse) SetStartedAt

func (o *BatchResponseSubscriptionResponse) SetStartedAt(v time.Time)

SetStartedAt sets field value

func (*BatchResponseSubscriptionResponse) SetStatus

func (o *BatchResponseSubscriptionResponse) SetStatus(v string)

SetStatus sets field value

type BatchResponseSubscriptionResponseWithErrors

type BatchResponseSubscriptionResponseWithErrors struct {
	Status      string                 `json:"status"`
	Results     []SubscriptionResponse `json:"results"`
	NumErrors   *int32                 `json:"numErrors,omitempty"`
	Errors      []StandardError        `json:"errors,omitempty"`
	RequestedAt *time.Time             `json:"requestedAt,omitempty"`
	StartedAt   time.Time              `json:"startedAt"`
	CompletedAt time.Time              `json:"completedAt"`
	Links       *map[string]string     `json:"links,omitempty"`
}

BatchResponseSubscriptionResponseWithErrors struct for BatchResponseSubscriptionResponseWithErrors

func NewBatchResponseSubscriptionResponseWithErrors

func NewBatchResponseSubscriptionResponseWithErrors(status string, results []SubscriptionResponse, startedAt time.Time, completedAt time.Time) *BatchResponseSubscriptionResponseWithErrors

NewBatchResponseSubscriptionResponseWithErrors instantiates a new BatchResponseSubscriptionResponseWithErrors 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 NewBatchResponseSubscriptionResponseWithErrorsWithDefaults

func NewBatchResponseSubscriptionResponseWithErrorsWithDefaults() *BatchResponseSubscriptionResponseWithErrors

NewBatchResponseSubscriptionResponseWithErrorsWithDefaults instantiates a new BatchResponseSubscriptionResponseWithErrors 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 (*BatchResponseSubscriptionResponseWithErrors) GetCompletedAt

GetCompletedAt returns the CompletedAt field value

func (*BatchResponseSubscriptionResponseWithErrors) GetCompletedAtOk

func (o *BatchResponseSubscriptionResponseWithErrors) GetCompletedAtOk() (*time.Time, bool)

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

func (*BatchResponseSubscriptionResponseWithErrors) GetErrors

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

func (*BatchResponseSubscriptionResponseWithErrors) GetErrorsOk

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

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

func (*BatchResponseSubscriptionResponseWithErrors) GetLinksOk

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 (*BatchResponseSubscriptionResponseWithErrors) GetNumErrors

GetNumErrors returns the NumErrors field value if set, zero value otherwise.

func (*BatchResponseSubscriptionResponseWithErrors) GetNumErrorsOk

func (o *BatchResponseSubscriptionResponseWithErrors) GetNumErrorsOk() (*int32, bool)

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

func (*BatchResponseSubscriptionResponseWithErrors) GetRequestedAt

GetRequestedAt returns the RequestedAt field value if set, zero value otherwise.

func (*BatchResponseSubscriptionResponseWithErrors) GetRequestedAtOk

func (o *BatchResponseSubscriptionResponseWithErrors) GetRequestedAtOk() (*time.Time, bool)

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

func (*BatchResponseSubscriptionResponseWithErrors) GetResults

GetResults returns the Results field value

func (*BatchResponseSubscriptionResponseWithErrors) GetResultsOk

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

func (*BatchResponseSubscriptionResponseWithErrors) GetStartedAt

GetStartedAt returns the StartedAt field value

func (*BatchResponseSubscriptionResponseWithErrors) GetStartedAtOk

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

func (*BatchResponseSubscriptionResponseWithErrors) GetStatus

GetStatus returns the Status field value

func (*BatchResponseSubscriptionResponseWithErrors) GetStatusOk

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

func (*BatchResponseSubscriptionResponseWithErrors) HasErrors

HasErrors returns a boolean if a field has been set.

HasLinks returns a boolean if a field has been set.

func (*BatchResponseSubscriptionResponseWithErrors) HasNumErrors

HasNumErrors returns a boolean if a field has been set.

func (*BatchResponseSubscriptionResponseWithErrors) HasRequestedAt

HasRequestedAt returns a boolean if a field has been set.

func (BatchResponseSubscriptionResponseWithErrors) MarshalJSON

func (*BatchResponseSubscriptionResponseWithErrors) SetCompletedAt

SetCompletedAt sets field value

func (*BatchResponseSubscriptionResponseWithErrors) SetErrors

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

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

func (*BatchResponseSubscriptionResponseWithErrors) SetNumErrors

SetNumErrors gets a reference to the given int32 and assigns it to the NumErrors field.

func (*BatchResponseSubscriptionResponseWithErrors) SetRequestedAt

SetRequestedAt gets a reference to the given time.Time and assigns it to the RequestedAt field.

func (*BatchResponseSubscriptionResponseWithErrors) SetResults

SetResults sets field value

func (*BatchResponseSubscriptionResponseWithErrors) SetStartedAt

SetStartedAt sets field value

func (*BatchResponseSubscriptionResponseWithErrors) SetStatus

SetStatus sets field value

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

Error struct for Error

func NewError

func NewError(message string, correlationId 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 ErrorCategory

type ErrorCategory struct {
	HttpStatus string `json:"httpStatus"`
	Name       string `json:"name"`
}

ErrorCategory struct for ErrorCategory

func NewErrorCategory

func NewErrorCategory(httpStatus string, name string) *ErrorCategory

NewErrorCategory instantiates a new ErrorCategory 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 NewErrorCategoryWithDefaults

func NewErrorCategoryWithDefaults() *ErrorCategory

NewErrorCategoryWithDefaults instantiates a new ErrorCategory 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 (*ErrorCategory) GetHttpStatus

func (o *ErrorCategory) GetHttpStatus() string

GetHttpStatus returns the HttpStatus field value

func (*ErrorCategory) GetHttpStatusOk

func (o *ErrorCategory) GetHttpStatusOk() (*string, bool)

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

func (*ErrorCategory) GetName

func (o *ErrorCategory) GetName() string

GetName returns the Name field value

func (*ErrorCategory) GetNameOk

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

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

func (ErrorCategory) MarshalJSON

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

func (*ErrorCategory) SetHttpStatus

func (o *ErrorCategory) SetHttpStatus(v string)

SetHttpStatus sets field value

func (*ErrorCategory) SetName

func (o *ErrorCategory) SetName(v string)

SetName sets field value

type ErrorDetail

type ErrorDetail struct {
	// A human readable message describing the error along with remediation steps where appropriate
	Message string `json:"message"`
	// The name of the field or parameter in which the error was found.
	In *string `json:"in,omitempty"`
	// The status code associated with the error detail
	Code *string `json:"code,omitempty"`
	// 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"`
}

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 NullableBatchInputSubscriptionBatchUpdateRequest

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

func (NullableBatchInputSubscriptionBatchUpdateRequest) Get

func (NullableBatchInputSubscriptionBatchUpdateRequest) IsSet

func (NullableBatchInputSubscriptionBatchUpdateRequest) MarshalJSON

func (*NullableBatchInputSubscriptionBatchUpdateRequest) Set

func (*NullableBatchInputSubscriptionBatchUpdateRequest) UnmarshalJSON

func (*NullableBatchInputSubscriptionBatchUpdateRequest) Unset

type NullableBatchResponseSubscriptionResponse

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

func (NullableBatchResponseSubscriptionResponse) Get

func (NullableBatchResponseSubscriptionResponse) IsSet

func (NullableBatchResponseSubscriptionResponse) MarshalJSON

func (*NullableBatchResponseSubscriptionResponse) Set

func (*NullableBatchResponseSubscriptionResponse) UnmarshalJSON

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

func (*NullableBatchResponseSubscriptionResponse) Unset

type NullableBatchResponseSubscriptionResponseWithErrors

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

func (NullableBatchResponseSubscriptionResponseWithErrors) Get

func (NullableBatchResponseSubscriptionResponseWithErrors) IsSet

func (NullableBatchResponseSubscriptionResponseWithErrors) MarshalJSON

func (*NullableBatchResponseSubscriptionResponseWithErrors) Set

func (*NullableBatchResponseSubscriptionResponseWithErrors) UnmarshalJSON

func (*NullableBatchResponseSubscriptionResponseWithErrors) Unset

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 NullableErrorCategory

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

func NewNullableErrorCategory

func NewNullableErrorCategory(val *ErrorCategory) *NullableErrorCategory

func (NullableErrorCategory) Get

func (NullableErrorCategory) IsSet

func (v NullableErrorCategory) IsSet() bool

func (NullableErrorCategory) MarshalJSON

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

func (*NullableErrorCategory) Set

func (v *NullableErrorCategory) Set(val *ErrorCategory)

func (*NullableErrorCategory) UnmarshalJSON

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

func (*NullableErrorCategory) Unset

func (v *NullableErrorCategory) Unset()

type NullableErrorDetail

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

func NewNullableErrorDetail

func NewNullableErrorDetail(val *ErrorDetail) *NullableErrorDetail

func (NullableErrorDetail) Get

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 NullableSettingsChangeRequest

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

func (NullableSettingsChangeRequest) Get

func (NullableSettingsChangeRequest) IsSet

func (NullableSettingsChangeRequest) MarshalJSON

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

func (*NullableSettingsChangeRequest) Set

func (*NullableSettingsChangeRequest) UnmarshalJSON

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

func (*NullableSettingsChangeRequest) Unset

func (v *NullableSettingsChangeRequest) Unset()

type NullableSettingsResponse

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

func NewNullableSettingsResponse

func NewNullableSettingsResponse(val *SettingsResponse) *NullableSettingsResponse

func (NullableSettingsResponse) Get

func (NullableSettingsResponse) IsSet

func (v NullableSettingsResponse) IsSet() bool

func (NullableSettingsResponse) MarshalJSON

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

func (*NullableSettingsResponse) Set

func (*NullableSettingsResponse) UnmarshalJSON

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

func (*NullableSettingsResponse) Unset

func (v *NullableSettingsResponse) Unset()

type NullableStandardError

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

func NewNullableStandardError

func NewNullableStandardError(val *StandardError) *NullableStandardError

func (NullableStandardError) Get

func (NullableStandardError) IsSet

func (v NullableStandardError) IsSet() bool

func (NullableStandardError) MarshalJSON

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

func (*NullableStandardError) Set

func (v *NullableStandardError) Set(val *StandardError)

func (*NullableStandardError) UnmarshalJSON

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

func (*NullableStandardError) Unset

func (v *NullableStandardError) 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 NullableSubscriptionBatchUpdateRequest

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

func (NullableSubscriptionBatchUpdateRequest) Get

func (NullableSubscriptionBatchUpdateRequest) IsSet

func (NullableSubscriptionBatchUpdateRequest) MarshalJSON

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

func (*NullableSubscriptionBatchUpdateRequest) Set

func (*NullableSubscriptionBatchUpdateRequest) UnmarshalJSON

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

func (*NullableSubscriptionBatchUpdateRequest) Unset

type NullableSubscriptionCreateRequest

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

func (NullableSubscriptionCreateRequest) Get

func (NullableSubscriptionCreateRequest) IsSet

func (NullableSubscriptionCreateRequest) MarshalJSON

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

func (*NullableSubscriptionCreateRequest) Set

func (*NullableSubscriptionCreateRequest) UnmarshalJSON

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

func (*NullableSubscriptionCreateRequest) Unset

type NullableSubscriptionListResponse

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

func (NullableSubscriptionListResponse) Get

func (NullableSubscriptionListResponse) IsSet

func (NullableSubscriptionListResponse) MarshalJSON

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

func (*NullableSubscriptionListResponse) Set

func (*NullableSubscriptionListResponse) UnmarshalJSON

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

func (*NullableSubscriptionListResponse) Unset

type NullableSubscriptionPatchRequest

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

func (NullableSubscriptionPatchRequest) Get

func (NullableSubscriptionPatchRequest) IsSet

func (NullableSubscriptionPatchRequest) MarshalJSON

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

func (*NullableSubscriptionPatchRequest) Set

func (*NullableSubscriptionPatchRequest) UnmarshalJSON

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

func (*NullableSubscriptionPatchRequest) Unset

type NullableSubscriptionResponse

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

func NewNullableSubscriptionResponse

func NewNullableSubscriptionResponse(val *SubscriptionResponse) *NullableSubscriptionResponse

func (NullableSubscriptionResponse) Get

func (NullableSubscriptionResponse) IsSet

func (NullableSubscriptionResponse) MarshalJSON

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

func (*NullableSubscriptionResponse) Set

func (*NullableSubscriptionResponse) UnmarshalJSON

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

func (*NullableSubscriptionResponse) Unset

func (v *NullableSubscriptionResponse) Unset()

type NullableThrottlingSettings

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

func NewNullableThrottlingSettings

func NewNullableThrottlingSettings(val *ThrottlingSettings) *NullableThrottlingSettings

func (NullableThrottlingSettings) Get

func (NullableThrottlingSettings) IsSet

func (v NullableThrottlingSettings) IsSet() bool

func (NullableThrottlingSettings) MarshalJSON

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

func (*NullableThrottlingSettings) Set

func (*NullableThrottlingSettings) UnmarshalJSON

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

func (*NullableThrottlingSettings) Unset

func (v *NullableThrottlingSettings) 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 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) SettingsClear

func (a *SettingsApiService) SettingsClear(ctx context.Context, appId int32) ApiSettingsClearRequest

SettingsClear Method for SettingsClear

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

func (*SettingsApiService) SettingsClearExecute

func (a *SettingsApiService) SettingsClearExecute(r ApiSettingsClearRequest) (*http.Response, error)

Execute executes the request

func (*SettingsApiService) SettingsConfigure

func (a *SettingsApiService) SettingsConfigure(ctx context.Context, appId int32) ApiSettingsConfigureRequest

SettingsConfigure Method for SettingsConfigure

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

func (*SettingsApiService) SettingsConfigureExecute

Execute executes the request

@return SettingsResponse

func (*SettingsApiService) SettingsGetAll

func (a *SettingsApiService) SettingsGetAll(ctx context.Context, appId int32) ApiSettingsGetAllRequest

SettingsGetAll Method for SettingsGetAll

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

func (*SettingsApiService) SettingsGetAllExecute

Execute executes the request

@return SettingsResponse

type SettingsChangeRequest

type SettingsChangeRequest struct {
	// A publicly available URL for Hubspot to call where event payloads will be delivered. See [link-so-some-doc](#) for details about the format of these event payloads.
	TargetUrl  string             `json:"targetUrl"`
	Throttling ThrottlingSettings `json:"throttling"`
}

SettingsChangeRequest New or updated webhook settings for an app.

func NewSettingsChangeRequest

func NewSettingsChangeRequest(targetUrl string, throttling ThrottlingSettings) *SettingsChangeRequest

NewSettingsChangeRequest instantiates a new SettingsChangeRequest 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 NewSettingsChangeRequestWithDefaults

func NewSettingsChangeRequestWithDefaults() *SettingsChangeRequest

NewSettingsChangeRequestWithDefaults instantiates a new SettingsChangeRequest 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 (*SettingsChangeRequest) GetTargetUrl

func (o *SettingsChangeRequest) GetTargetUrl() string

GetTargetUrl returns the TargetUrl field value

func (*SettingsChangeRequest) GetTargetUrlOk

func (o *SettingsChangeRequest) GetTargetUrlOk() (*string, bool)

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

func (*SettingsChangeRequest) GetThrottling

func (o *SettingsChangeRequest) GetThrottling() ThrottlingSettings

GetThrottling returns the Throttling field value

func (*SettingsChangeRequest) GetThrottlingOk

func (o *SettingsChangeRequest) GetThrottlingOk() (*ThrottlingSettings, bool)

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

func (SettingsChangeRequest) MarshalJSON

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

func (*SettingsChangeRequest) SetTargetUrl

func (o *SettingsChangeRequest) SetTargetUrl(v string)

SetTargetUrl sets field value

func (*SettingsChangeRequest) SetThrottling

func (o *SettingsChangeRequest) SetThrottling(v ThrottlingSettings)

SetThrottling sets field value

type SettingsResponse

type SettingsResponse struct {
	// A publicly available URL for Hubspot to call where event payloads will be delivered. See [link-so-some-doc](#) for details about the format of these event payloads.
	TargetUrl  string             `json:"targetUrl"`
	Throttling ThrottlingSettings `json:"throttling"`
	// When this subscription was created. Formatted as milliseconds from the [Unix epoch](#).
	CreatedAt time.Time `json:"createdAt"`
	// When this subscription was last updated. Formatted as milliseconds from the [Unix epoch](#).
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
}

SettingsResponse Webhook settings for an app.

func NewSettingsResponse

func NewSettingsResponse(targetUrl string, throttling ThrottlingSettings, createdAt 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) GetTargetUrl

func (o *SettingsResponse) GetTargetUrl() string

GetTargetUrl returns the TargetUrl field value

func (*SettingsResponse) GetTargetUrlOk

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

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

func (*SettingsResponse) GetThrottling

func (o *SettingsResponse) GetThrottling() ThrottlingSettings

GetThrottling returns the Throttling field value

func (*SettingsResponse) GetThrottlingOk

func (o *SettingsResponse) GetThrottlingOk() (*ThrottlingSettings, bool)

GetThrottlingOk returns a tuple with the Throttling 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 if set, zero value otherwise.

func (*SettingsResponse) GetUpdatedAtOk

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

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

func (*SettingsResponse) HasUpdatedAt

func (o *SettingsResponse) HasUpdatedAt() bool

HasUpdatedAt returns a boolean if a field 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) SetTargetUrl

func (o *SettingsResponse) SetTargetUrl(v string)

SetTargetUrl sets field value

func (*SettingsResponse) SetThrottling

func (o *SettingsResponse) SetThrottling(v ThrottlingSettings)

SetThrottling sets field value

func (*SettingsResponse) SetUpdatedAt

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

SetUpdatedAt gets a reference to the given time.Time and assigns it to the UpdatedAt field.

type StandardError

type StandardError struct {
	Status      string                 `json:"status"`
	Id          *string                `json:"id,omitempty"`
	Category    ErrorCategory          `json:"category"`
	SubCategory map[string]interface{} `json:"subCategory,omitempty"`
	Message     string                 `json:"message"`
	Errors      []ErrorDetail          `json:"errors"`
	Context     map[string][]string    `json:"context"`
	Links       map[string]string      `json:"links"`
}

StandardError struct for StandardError

func NewStandardError

func NewStandardError(status string, category ErrorCategory, message string, errors []ErrorDetail, context map[string][]string, links map[string]string) *StandardError

NewStandardError instantiates a new StandardError 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 NewStandardErrorWithDefaults

func NewStandardErrorWithDefaults() *StandardError

NewStandardErrorWithDefaults instantiates a new StandardError 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 (*StandardError) GetCategory

func (o *StandardError) GetCategory() ErrorCategory

GetCategory returns the Category field value

func (*StandardError) GetCategoryOk

func (o *StandardError) GetCategoryOk() (*ErrorCategory, bool)

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

func (*StandardError) GetContext

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

GetContext returns the Context field value

func (*StandardError) GetContextOk

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

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

func (*StandardError) GetErrors

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

GetErrors returns the Errors field value

func (*StandardError) GetErrorsOk

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

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

func (*StandardError) GetId

func (o *StandardError) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*StandardError) GetIdOk

func (o *StandardError) GetIdOk() (*string, bool)

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

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

GetLinks returns the Links field value

func (*StandardError) GetLinksOk

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

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

func (*StandardError) GetMessage

func (o *StandardError) GetMessage() string

GetMessage returns the Message field value

func (*StandardError) GetMessageOk

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

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

func (*StandardError) GetStatus

func (o *StandardError) GetStatus() string

GetStatus returns the Status field value

func (*StandardError) GetStatusOk

func (o *StandardError) GetStatusOk() (*string, bool)

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

func (*StandardError) GetSubCategory

func (o *StandardError) GetSubCategory() map[string]interface{}

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

func (*StandardError) GetSubCategoryOk

func (o *StandardError) GetSubCategoryOk() (map[string]interface{}, 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 (*StandardError) HasId

func (o *StandardError) HasId() bool

HasId returns a boolean if a field has been set.

func (*StandardError) HasSubCategory

func (o *StandardError) HasSubCategory() bool

HasSubCategory returns a boolean if a field has been set.

func (StandardError) MarshalJSON

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

func (*StandardError) SetCategory

func (o *StandardError) SetCategory(v ErrorCategory)

SetCategory sets field value

func (*StandardError) SetContext

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

SetContext sets field value

func (*StandardError) SetErrors

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

SetErrors sets field value

func (*StandardError) SetId

func (o *StandardError) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

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

SetLinks sets field value

func (*StandardError) SetMessage

func (o *StandardError) SetMessage(v string)

SetMessage sets field value

func (*StandardError) SetStatus

func (o *StandardError) SetStatus(v string)

SetStatus sets field value

func (*StandardError) SetSubCategory

func (o *StandardError) SetSubCategory(v map[string]interface{})

SetSubCategory gets a reference to the given map[string]interface{} and assigns it to the SubCategory field.

type SubscriptionBatchUpdateRequest

type SubscriptionBatchUpdateRequest struct {
	Id     int32 `json:"id"`
	Active bool  `json:"active"`
}

SubscriptionBatchUpdateRequest struct for SubscriptionBatchUpdateRequest

func NewSubscriptionBatchUpdateRequest

func NewSubscriptionBatchUpdateRequest(id int32, active bool) *SubscriptionBatchUpdateRequest

NewSubscriptionBatchUpdateRequest instantiates a new SubscriptionBatchUpdateRequest 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 NewSubscriptionBatchUpdateRequestWithDefaults

func NewSubscriptionBatchUpdateRequestWithDefaults() *SubscriptionBatchUpdateRequest

NewSubscriptionBatchUpdateRequestWithDefaults instantiates a new SubscriptionBatchUpdateRequest 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 (*SubscriptionBatchUpdateRequest) GetActive

func (o *SubscriptionBatchUpdateRequest) GetActive() bool

GetActive returns the Active field value

func (*SubscriptionBatchUpdateRequest) GetActiveOk

func (o *SubscriptionBatchUpdateRequest) GetActiveOk() (*bool, bool)

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

func (*SubscriptionBatchUpdateRequest) GetId

GetId returns the Id field value

func (*SubscriptionBatchUpdateRequest) GetIdOk

func (o *SubscriptionBatchUpdateRequest) GetIdOk() (*int32, bool)

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

func (SubscriptionBatchUpdateRequest) MarshalJSON

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

func (*SubscriptionBatchUpdateRequest) SetActive

func (o *SubscriptionBatchUpdateRequest) SetActive(v bool)

SetActive sets field value

func (*SubscriptionBatchUpdateRequest) SetId

SetId sets field value

type SubscriptionCreateRequest

type SubscriptionCreateRequest struct {
	// Type of event to listen for. Can be one of `create`, `delete`, `deletedForPrivacy`, or `propertyChange`.
	EventType string `json:"eventType"`
	// The internal name of the property to monitor for changes. Only applies when `eventType` is `propertyChange`.
	PropertyName *string `json:"propertyName,omitempty"`
	// Determines if the subscription is active or paused. Defaults to false.
	Active *bool `json:"active,omitempty"`
}

SubscriptionCreateRequest New webhook settings for an app.

func NewSubscriptionCreateRequest

func NewSubscriptionCreateRequest(eventType string) *SubscriptionCreateRequest

NewSubscriptionCreateRequest instantiates a new SubscriptionCreateRequest 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 NewSubscriptionCreateRequestWithDefaults

func NewSubscriptionCreateRequestWithDefaults() *SubscriptionCreateRequest

NewSubscriptionCreateRequestWithDefaults instantiates a new SubscriptionCreateRequest 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 (*SubscriptionCreateRequest) GetActive

func (o *SubscriptionCreateRequest) GetActive() bool

GetActive returns the Active field value if set, zero value otherwise.

func (*SubscriptionCreateRequest) GetActiveOk

func (o *SubscriptionCreateRequest) GetActiveOk() (*bool, bool)

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

func (*SubscriptionCreateRequest) GetEventType

func (o *SubscriptionCreateRequest) GetEventType() string

GetEventType returns the EventType field value

func (*SubscriptionCreateRequest) GetEventTypeOk

func (o *SubscriptionCreateRequest) GetEventTypeOk() (*string, bool)

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

func (*SubscriptionCreateRequest) GetPropertyName

func (o *SubscriptionCreateRequest) GetPropertyName() string

GetPropertyName returns the PropertyName field value if set, zero value otherwise.

func (*SubscriptionCreateRequest) GetPropertyNameOk

func (o *SubscriptionCreateRequest) GetPropertyNameOk() (*string, bool)

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

func (*SubscriptionCreateRequest) HasActive

func (o *SubscriptionCreateRequest) HasActive() bool

HasActive returns a boolean if a field has been set.

func (*SubscriptionCreateRequest) HasPropertyName

func (o *SubscriptionCreateRequest) HasPropertyName() bool

HasPropertyName returns a boolean if a field has been set.

func (SubscriptionCreateRequest) MarshalJSON

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

func (*SubscriptionCreateRequest) SetActive

func (o *SubscriptionCreateRequest) SetActive(v bool)

SetActive gets a reference to the given bool and assigns it to the Active field.

func (*SubscriptionCreateRequest) SetEventType

func (o *SubscriptionCreateRequest) SetEventType(v string)

SetEventType sets field value

func (*SubscriptionCreateRequest) SetPropertyName

func (o *SubscriptionCreateRequest) SetPropertyName(v string)

SetPropertyName gets a reference to the given string and assigns it to the PropertyName field.

type SubscriptionListResponse

type SubscriptionListResponse struct {
	// List of event subscriptions for your app
	Results []SubscriptionResponse `json:"results"`
}

SubscriptionListResponse List of event subscriptions for your app

func NewSubscriptionListResponse

func NewSubscriptionListResponse(results []SubscriptionResponse) *SubscriptionListResponse

NewSubscriptionListResponse instantiates a new SubscriptionListResponse 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 NewSubscriptionListResponseWithDefaults

func NewSubscriptionListResponseWithDefaults() *SubscriptionListResponse

NewSubscriptionListResponseWithDefaults instantiates a new SubscriptionListResponse 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 (*SubscriptionListResponse) GetResults

GetResults returns the Results field value

func (*SubscriptionListResponse) GetResultsOk

func (o *SubscriptionListResponse) GetResultsOk() ([]SubscriptionResponse, bool)

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

func (SubscriptionListResponse) MarshalJSON

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

func (*SubscriptionListResponse) SetResults

SetResults sets field value

type SubscriptionPatchRequest

type SubscriptionPatchRequest struct {
	// Determines if the subscription is active or paused.
	Active *bool `json:"active,omitempty"`
}

SubscriptionPatchRequest Updated details for the subscription.

func NewSubscriptionPatchRequest

func NewSubscriptionPatchRequest() *SubscriptionPatchRequest

NewSubscriptionPatchRequest instantiates a new SubscriptionPatchRequest 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 NewSubscriptionPatchRequestWithDefaults

func NewSubscriptionPatchRequestWithDefaults() *SubscriptionPatchRequest

NewSubscriptionPatchRequestWithDefaults instantiates a new SubscriptionPatchRequest 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 (*SubscriptionPatchRequest) GetActive

func (o *SubscriptionPatchRequest) GetActive() bool

GetActive returns the Active field value if set, zero value otherwise.

func (*SubscriptionPatchRequest) GetActiveOk

func (o *SubscriptionPatchRequest) GetActiveOk() (*bool, bool)

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

func (*SubscriptionPatchRequest) HasActive

func (o *SubscriptionPatchRequest) HasActive() bool

HasActive returns a boolean if a field has been set.

func (SubscriptionPatchRequest) MarshalJSON

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

func (*SubscriptionPatchRequest) SetActive

func (o *SubscriptionPatchRequest) SetActive(v bool)

SetActive gets a reference to the given bool and assigns it to the Active field.

type SubscriptionResponse

type SubscriptionResponse struct {
	// Type of event to listen for. Can be one of `create`, `delete`, `deletedForPrivacy`, or `propertyChange`.
	EventType string `json:"eventType"`
	// The internal name of the property being monitored for changes. Only applies when `eventType` is `propertyChange`.
	PropertyName *string `json:"propertyName,omitempty"`
	// Determines if the subscription is active or paused.
	Active bool `json:"active"`
	// The unique ID of the subscription.
	Id string `json:"id"`
	// When this subscription was created. Formatted as milliseconds from the [Unix epoch](#).
	CreatedAt time.Time `json:"createdAt"`
	// When this subscription was last updated. Formatted as milliseconds from the [Unix epoch](#).
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
}

SubscriptionResponse Complete details for an event subscription.

func NewSubscriptionResponse

func NewSubscriptionResponse(eventType string, active bool, id string, createdAt time.Time) *SubscriptionResponse

NewSubscriptionResponse instantiates a new SubscriptionResponse 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 NewSubscriptionResponseWithDefaults

func NewSubscriptionResponseWithDefaults() *SubscriptionResponse

NewSubscriptionResponseWithDefaults instantiates a new SubscriptionResponse 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 (*SubscriptionResponse) GetActive

func (o *SubscriptionResponse) GetActive() bool

GetActive returns the Active field value

func (*SubscriptionResponse) GetActiveOk

func (o *SubscriptionResponse) GetActiveOk() (*bool, bool)

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

func (*SubscriptionResponse) GetCreatedAt

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

GetCreatedAt returns the CreatedAt field value

func (*SubscriptionResponse) GetCreatedAtOk

func (o *SubscriptionResponse) 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 (*SubscriptionResponse) GetEventType

func (o *SubscriptionResponse) GetEventType() string

GetEventType returns the EventType field value

func (*SubscriptionResponse) GetEventTypeOk

func (o *SubscriptionResponse) GetEventTypeOk() (*string, bool)

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

func (*SubscriptionResponse) GetId

func (o *SubscriptionResponse) GetId() string

GetId returns the Id field value

func (*SubscriptionResponse) GetIdOk

func (o *SubscriptionResponse) GetIdOk() (*string, bool)

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

func (*SubscriptionResponse) GetPropertyName

func (o *SubscriptionResponse) GetPropertyName() string

GetPropertyName returns the PropertyName field value if set, zero value otherwise.

func (*SubscriptionResponse) GetPropertyNameOk

func (o *SubscriptionResponse) GetPropertyNameOk() (*string, bool)

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

func (*SubscriptionResponse) GetUpdatedAt

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

GetUpdatedAt returns the UpdatedAt field value if set, zero value otherwise.

func (*SubscriptionResponse) GetUpdatedAtOk

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

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

func (*SubscriptionResponse) HasPropertyName

func (o *SubscriptionResponse) HasPropertyName() bool

HasPropertyName returns a boolean if a field has been set.

func (*SubscriptionResponse) HasUpdatedAt

func (o *SubscriptionResponse) HasUpdatedAt() bool

HasUpdatedAt returns a boolean if a field has been set.

func (SubscriptionResponse) MarshalJSON

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

func (*SubscriptionResponse) SetActive

func (o *SubscriptionResponse) SetActive(v bool)

SetActive sets field value

func (*SubscriptionResponse) SetCreatedAt

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

SetCreatedAt sets field value

func (*SubscriptionResponse) SetEventType

func (o *SubscriptionResponse) SetEventType(v string)

SetEventType sets field value

func (*SubscriptionResponse) SetId

func (o *SubscriptionResponse) SetId(v string)

SetId sets field value

func (*SubscriptionResponse) SetPropertyName

func (o *SubscriptionResponse) SetPropertyName(v string)

SetPropertyName gets a reference to the given string and assigns it to the PropertyName field.

func (*SubscriptionResponse) SetUpdatedAt

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

SetUpdatedAt gets a reference to the given time.Time and assigns it to the UpdatedAt field.

type SubscriptionsApiService

type SubscriptionsApiService service

SubscriptionsApiService SubscriptionsApi service

func (*SubscriptionsApiService) SubscriptionsArchive

func (a *SubscriptionsApiService) SubscriptionsArchive(ctx context.Context, subscriptionId int32, appId int32) ApiSubscriptionsArchiveRequest

SubscriptionsArchive Method for SubscriptionsArchive

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

func (*SubscriptionsApiService) SubscriptionsArchiveExecute

func (a *SubscriptionsApiService) SubscriptionsArchiveExecute(r ApiSubscriptionsArchiveRequest) (*http.Response, error)

Execute executes the request

func (*SubscriptionsApiService) SubscriptionsBatchUpdate

func (a *SubscriptionsApiService) SubscriptionsBatchUpdate(ctx context.Context, appId int32) ApiSubscriptionsBatchUpdateRequest

SubscriptionsBatchUpdate Method for SubscriptionsBatchUpdate

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

func (*SubscriptionsApiService) SubscriptionsBatchUpdateExecute

Execute executes the request

@return BatchResponseSubscriptionResponse

func (*SubscriptionsApiService) SubscriptionsCreate

func (a *SubscriptionsApiService) SubscriptionsCreate(ctx context.Context, appId int32) ApiSubscriptionsCreateRequest

SubscriptionsCreate Method for SubscriptionsCreate

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

func (*SubscriptionsApiService) SubscriptionsCreateExecute

Execute executes the request

@return SubscriptionResponse

func (*SubscriptionsApiService) SubscriptionsGetAll

func (a *SubscriptionsApiService) SubscriptionsGetAll(ctx context.Context, appId int32) ApiSubscriptionsGetAllRequest

SubscriptionsGetAll Method for SubscriptionsGetAll

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

func (*SubscriptionsApiService) SubscriptionsGetAllExecute

Execute executes the request

@return SubscriptionListResponse

func (*SubscriptionsApiService) SubscriptionsGetByID

func (a *SubscriptionsApiService) SubscriptionsGetByID(ctx context.Context, subscriptionId int32, appId int32) ApiSubscriptionsGetByIDRequest

SubscriptionsGetByID Method for SubscriptionsGetByID

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

func (*SubscriptionsApiService) SubscriptionsGetByIDExecute

Execute executes the request

@return SubscriptionResponse

func (*SubscriptionsApiService) SubscriptionsUpdate

func (a *SubscriptionsApiService) SubscriptionsUpdate(ctx context.Context, subscriptionId int32, appId int32) ApiSubscriptionsUpdateRequest

SubscriptionsUpdate Method for SubscriptionsUpdate

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

func (*SubscriptionsApiService) SubscriptionsUpdateExecute

Execute executes the request

@return SubscriptionResponse

type ThrottlingSettings

type ThrottlingSettings struct {
	// The maximum number of HTTP requests HubSpot will attempt to make to your app in a given time frame determined by `period`.
	MaxConcurrentRequests int32 `json:"maxConcurrentRequests"`
	// Time scale for this setting. Can be either `SECONDLY` (per second) or `ROLLING_MINUTE` (per minute).
	Period string `json:"period"`
}

ThrottlingSettings Configuration details for webhook throttling.

func NewThrottlingSettings

func NewThrottlingSettings(maxConcurrentRequests int32, period string) *ThrottlingSettings

NewThrottlingSettings instantiates a new ThrottlingSettings 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 NewThrottlingSettingsWithDefaults

func NewThrottlingSettingsWithDefaults() *ThrottlingSettings

NewThrottlingSettingsWithDefaults instantiates a new ThrottlingSettings 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 (*ThrottlingSettings) GetMaxConcurrentRequests

func (o *ThrottlingSettings) GetMaxConcurrentRequests() int32

GetMaxConcurrentRequests returns the MaxConcurrentRequests field value

func (*ThrottlingSettings) GetMaxConcurrentRequestsOk

func (o *ThrottlingSettings) GetMaxConcurrentRequestsOk() (*int32, bool)

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

func (*ThrottlingSettings) GetPeriod

func (o *ThrottlingSettings) GetPeriod() string

GetPeriod returns the Period field value

func (*ThrottlingSettings) GetPeriodOk

func (o *ThrottlingSettings) GetPeriodOk() (*string, bool)

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

func (ThrottlingSettings) MarshalJSON

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

func (*ThrottlingSettings) SetMaxConcurrentRequests

func (o *ThrottlingSettings) SetMaxConcurrentRequests(v int32)

SetMaxConcurrentRequests sets field value

func (*ThrottlingSettings) SetPeriod

func (o *ThrottlingSettings) SetPeriod(v string)

SetPeriod sets field value

Jump to

Keyboard shortcuts

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