communications_status

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 communications_status

Subscriptions allow contacts to control what forms of communications they receive. Contacts can decide whether they want to receive communication pertaining to a specific topic, brand, or an entire HubSpot account.

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 communications_status "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(), communications_status.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(), communications_status.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(), communications_status.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), communications_status.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
DefinitionApi GetPage Get /communication-preferences/v3/definitions Get subscription definitions
StatusApi GetEmailStatus Get /communication-preferences/v3/status/email/{emailAddress} Get subscription statuses for a contact
StatusApi Subscribe Post /communication-preferences/v3/subscribe Subscribe a contact
StatusApi Unsubscribe Post /communication-preferences/v3/unsubscribe Unsubscribe a contact

Documentation For Models

Documentation For Authorization

oauth2_legacy
  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: https://app.hubspot.com/oauth/authorize
  • Scopes:
  • communication_preferences.read: Read contact subscription preferences
  • communication_preferences.read_write: Update contact subscription preferences
  • communication_preferences.write: Update contact subscription preferences

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)
private_apps_legacy
  • Type: API key
  • API key parameter name: private-app-legacy
  • Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: private-app-legacy 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 {
	DefinitionApi *DefinitionApiService

	StatusApi *StatusApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Subscriptions 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 ApiGetEmailStatusRequest

type ApiGetEmailStatusRequest struct {
	ApiService *StatusApiService
	// contains filtered or unexported fields
}

func (ApiGetEmailStatusRequest) Execute

type ApiGetPageRequest

type ApiGetPageRequest struct {
	ApiService *DefinitionApiService
	// contains filtered or unexported fields
}

func (ApiGetPageRequest) Execute

type ApiSubscribeRequest

type ApiSubscribeRequest struct {
	ApiService *StatusApiService
	// contains filtered or unexported fields
}

func (ApiSubscribeRequest) Execute

func (ApiSubscribeRequest) PublicUpdateSubscriptionStatusRequest

func (r ApiSubscribeRequest) PublicUpdateSubscriptionStatusRequest(publicUpdateSubscriptionStatusRequest PublicUpdateSubscriptionStatusRequest) ApiSubscribeRequest

type ApiUnsubscribeRequest

type ApiUnsubscribeRequest struct {
	ApiService *StatusApiService
	// contains filtered or unexported fields
}

func (ApiUnsubscribeRequest) Execute

func (ApiUnsubscribeRequest) PublicUpdateSubscriptionStatusRequest

func (r ApiUnsubscribeRequest) PublicUpdateSubscriptionStatusRequest(publicUpdateSubscriptionStatusRequest PublicUpdateSubscriptionStatusRequest) ApiUnsubscribeRequest

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 DefinitionApiService

type DefinitionApiService service

DefinitionApiService DefinitionApi service

func (*DefinitionApiService) GetPage

GetPage Get subscription definitions

Get a list of all subscription definitions for the portal

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

func (*DefinitionApiService) GetPageExecute

Execute executes the request

@return SubscriptionDefinitionsResponse

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 (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 NullablePublicSubscriptionStatus

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

func (NullablePublicSubscriptionStatus) Get

func (NullablePublicSubscriptionStatus) IsSet

func (NullablePublicSubscriptionStatus) MarshalJSON

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

func (*NullablePublicSubscriptionStatus) Set

func (*NullablePublicSubscriptionStatus) UnmarshalJSON

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

func (*NullablePublicSubscriptionStatus) Unset

type NullablePublicSubscriptionStatusesResponse

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

func (NullablePublicSubscriptionStatusesResponse) Get

func (NullablePublicSubscriptionStatusesResponse) IsSet

func (NullablePublicSubscriptionStatusesResponse) MarshalJSON

func (*NullablePublicSubscriptionStatusesResponse) Set

func (*NullablePublicSubscriptionStatusesResponse) UnmarshalJSON

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

func (*NullablePublicSubscriptionStatusesResponse) Unset

type NullablePublicUpdateSubscriptionStatusRequest

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

func (NullablePublicUpdateSubscriptionStatusRequest) Get

func (NullablePublicUpdateSubscriptionStatusRequest) IsSet

func (NullablePublicUpdateSubscriptionStatusRequest) MarshalJSON

func (*NullablePublicUpdateSubscriptionStatusRequest) Set

func (*NullablePublicUpdateSubscriptionStatusRequest) UnmarshalJSON

func (*NullablePublicUpdateSubscriptionStatusRequest) 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 NullableSubscriptionDefinition

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

func (NullableSubscriptionDefinition) Get

func (NullableSubscriptionDefinition) IsSet

func (NullableSubscriptionDefinition) MarshalJSON

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

func (*NullableSubscriptionDefinition) Set

func (*NullableSubscriptionDefinition) UnmarshalJSON

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

func (*NullableSubscriptionDefinition) Unset

func (v *NullableSubscriptionDefinition) Unset()

type NullableSubscriptionDefinitionsResponse

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

func (NullableSubscriptionDefinitionsResponse) Get

func (NullableSubscriptionDefinitionsResponse) IsSet

func (NullableSubscriptionDefinitionsResponse) MarshalJSON

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

func (*NullableSubscriptionDefinitionsResponse) Set

func (*NullableSubscriptionDefinitionsResponse) UnmarshalJSON

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

func (*NullableSubscriptionDefinitionsResponse) 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 PublicSubscriptionStatus

type PublicSubscriptionStatus struct {
	// The ID of the brand that the subscription is associated with, if there is one.
	BrandId *int64 `json:"brandId,omitempty"`
	// The name of the subscription.
	Name string `json:"name"`
	// A description of the subscription.
	Description string `json:"description"`
	// The legal reason for the current status of the subscription.
	LegalBasis *string `json:"legalBasis,omitempty"`
	// The name of the preferences group that the subscription is associated with.
	PreferenceGroupName *string `json:"preferenceGroupName,omitempty"`
	// The ID for the subscription.
	Id string `json:"id"`
	// A more detailed explanation to go with the legal basis.
	LegalBasisExplanation *string `json:"legalBasisExplanation,omitempty"`
	// Whether the contact is subscribed.
	Status string `json:"status"`
	// Where the status is determined from e.g. PORTAL_WIDE_STATUS if the contact opted out from the portal.
	SourceOfStatus string `json:"sourceOfStatus"`
}

PublicSubscriptionStatus The status of a subscription for a contact.

func NewPublicSubscriptionStatus

func NewPublicSubscriptionStatus(name string, description string, id string, status string, sourceOfStatus string) *PublicSubscriptionStatus

NewPublicSubscriptionStatus instantiates a new PublicSubscriptionStatus 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 NewPublicSubscriptionStatusWithDefaults

func NewPublicSubscriptionStatusWithDefaults() *PublicSubscriptionStatus

NewPublicSubscriptionStatusWithDefaults instantiates a new PublicSubscriptionStatus 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 (*PublicSubscriptionStatus) GetBrandId

func (o *PublicSubscriptionStatus) GetBrandId() int64

GetBrandId returns the BrandId field value if set, zero value otherwise.

func (*PublicSubscriptionStatus) GetBrandIdOk

func (o *PublicSubscriptionStatus) GetBrandIdOk() (*int64, bool)

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

func (*PublicSubscriptionStatus) GetDescription

func (o *PublicSubscriptionStatus) GetDescription() string

GetDescription returns the Description field value

func (*PublicSubscriptionStatus) GetDescriptionOk

func (o *PublicSubscriptionStatus) GetDescriptionOk() (*string, bool)

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

func (*PublicSubscriptionStatus) GetId

func (o *PublicSubscriptionStatus) GetId() string

GetId returns the Id field value

func (*PublicSubscriptionStatus) GetIdOk

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

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

func (*PublicSubscriptionStatus) GetLegalBasis

func (o *PublicSubscriptionStatus) GetLegalBasis() string

GetLegalBasis returns the LegalBasis field value if set, zero value otherwise.

func (*PublicSubscriptionStatus) GetLegalBasisExplanation

func (o *PublicSubscriptionStatus) GetLegalBasisExplanation() string

GetLegalBasisExplanation returns the LegalBasisExplanation field value if set, zero value otherwise.

func (*PublicSubscriptionStatus) GetLegalBasisExplanationOk

func (o *PublicSubscriptionStatus) GetLegalBasisExplanationOk() (*string, bool)

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

func (*PublicSubscriptionStatus) GetLegalBasisOk

func (o *PublicSubscriptionStatus) GetLegalBasisOk() (*string, bool)

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

func (*PublicSubscriptionStatus) GetName

func (o *PublicSubscriptionStatus) GetName() string

GetName returns the Name field value

func (*PublicSubscriptionStatus) GetNameOk

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

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

func (*PublicSubscriptionStatus) GetPreferenceGroupName

func (o *PublicSubscriptionStatus) GetPreferenceGroupName() string

GetPreferenceGroupName returns the PreferenceGroupName field value if set, zero value otherwise.

func (*PublicSubscriptionStatus) GetPreferenceGroupNameOk

func (o *PublicSubscriptionStatus) GetPreferenceGroupNameOk() (*string, bool)

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

func (*PublicSubscriptionStatus) GetSourceOfStatus

func (o *PublicSubscriptionStatus) GetSourceOfStatus() string

GetSourceOfStatus returns the SourceOfStatus field value

func (*PublicSubscriptionStatus) GetSourceOfStatusOk

func (o *PublicSubscriptionStatus) GetSourceOfStatusOk() (*string, bool)

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

func (*PublicSubscriptionStatus) GetStatus

func (o *PublicSubscriptionStatus) GetStatus() string

GetStatus returns the Status field value

func (*PublicSubscriptionStatus) GetStatusOk

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

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

func (*PublicSubscriptionStatus) HasBrandId

func (o *PublicSubscriptionStatus) HasBrandId() bool

HasBrandId returns a boolean if a field has been set.

func (*PublicSubscriptionStatus) HasLegalBasis

func (o *PublicSubscriptionStatus) HasLegalBasis() bool

HasLegalBasis returns a boolean if a field has been set.

func (*PublicSubscriptionStatus) HasLegalBasisExplanation

func (o *PublicSubscriptionStatus) HasLegalBasisExplanation() bool

HasLegalBasisExplanation returns a boolean if a field has been set.

func (*PublicSubscriptionStatus) HasPreferenceGroupName

func (o *PublicSubscriptionStatus) HasPreferenceGroupName() bool

HasPreferenceGroupName returns a boolean if a field has been set.

func (PublicSubscriptionStatus) MarshalJSON

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

func (*PublicSubscriptionStatus) SetBrandId

func (o *PublicSubscriptionStatus) SetBrandId(v int64)

SetBrandId gets a reference to the given int64 and assigns it to the BrandId field.

func (*PublicSubscriptionStatus) SetDescription

func (o *PublicSubscriptionStatus) SetDescription(v string)

SetDescription sets field value

func (*PublicSubscriptionStatus) SetId

func (o *PublicSubscriptionStatus) SetId(v string)

SetId sets field value

func (*PublicSubscriptionStatus) SetLegalBasis

func (o *PublicSubscriptionStatus) SetLegalBasis(v string)

SetLegalBasis gets a reference to the given string and assigns it to the LegalBasis field.

func (*PublicSubscriptionStatus) SetLegalBasisExplanation

func (o *PublicSubscriptionStatus) SetLegalBasisExplanation(v string)

SetLegalBasisExplanation gets a reference to the given string and assigns it to the LegalBasisExplanation field.

func (*PublicSubscriptionStatus) SetName

func (o *PublicSubscriptionStatus) SetName(v string)

SetName sets field value

func (*PublicSubscriptionStatus) SetPreferenceGroupName

func (o *PublicSubscriptionStatus) SetPreferenceGroupName(v string)

SetPreferenceGroupName gets a reference to the given string and assigns it to the PreferenceGroupName field.

func (*PublicSubscriptionStatus) SetSourceOfStatus

func (o *PublicSubscriptionStatus) SetSourceOfStatus(v string)

SetSourceOfStatus sets field value

func (*PublicSubscriptionStatus) SetStatus

func (o *PublicSubscriptionStatus) SetStatus(v string)

SetStatus sets field value

type PublicSubscriptionStatusesResponse

type PublicSubscriptionStatusesResponse struct {
	// Email address of the contact.
	Recipient string `json:"recipient"`
	// A list of all of the contact's subscriptions statuses.
	SubscriptionStatuses []PublicSubscriptionStatus `json:"subscriptionStatuses"`
}

PublicSubscriptionStatusesResponse A collection of subscription statuses for a contact.

func NewPublicSubscriptionStatusesResponse

func NewPublicSubscriptionStatusesResponse(recipient string, subscriptionStatuses []PublicSubscriptionStatus) *PublicSubscriptionStatusesResponse

NewPublicSubscriptionStatusesResponse instantiates a new PublicSubscriptionStatusesResponse 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 NewPublicSubscriptionStatusesResponseWithDefaults

func NewPublicSubscriptionStatusesResponseWithDefaults() *PublicSubscriptionStatusesResponse

NewPublicSubscriptionStatusesResponseWithDefaults instantiates a new PublicSubscriptionStatusesResponse 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 (*PublicSubscriptionStatusesResponse) GetRecipient

func (o *PublicSubscriptionStatusesResponse) GetRecipient() string

GetRecipient returns the Recipient field value

func (*PublicSubscriptionStatusesResponse) GetRecipientOk

func (o *PublicSubscriptionStatusesResponse) GetRecipientOk() (*string, bool)

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

func (*PublicSubscriptionStatusesResponse) GetSubscriptionStatuses

func (o *PublicSubscriptionStatusesResponse) GetSubscriptionStatuses() []PublicSubscriptionStatus

GetSubscriptionStatuses returns the SubscriptionStatuses field value

func (*PublicSubscriptionStatusesResponse) GetSubscriptionStatusesOk

func (o *PublicSubscriptionStatusesResponse) GetSubscriptionStatusesOk() ([]PublicSubscriptionStatus, bool)

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

func (PublicSubscriptionStatusesResponse) MarshalJSON

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

func (*PublicSubscriptionStatusesResponse) SetRecipient

func (o *PublicSubscriptionStatusesResponse) SetRecipient(v string)

SetRecipient sets field value

func (*PublicSubscriptionStatusesResponse) SetSubscriptionStatuses

func (o *PublicSubscriptionStatusesResponse) SetSubscriptionStatuses(v []PublicSubscriptionStatus)

SetSubscriptionStatuses sets field value

type PublicUpdateSubscriptionStatusRequest

type PublicUpdateSubscriptionStatusRequest struct {
	// Contact's email address.
	EmailAddress string `json:"emailAddress"`
	// Legal basis for updating the contact's status (required for GDPR enabled portals).
	LegalBasis *string `json:"legalBasis,omitempty"`
	// ID of the subscription being updated for the contact.
	SubscriptionId string `json:"subscriptionId"`
	// A more detailed explanation to go with the legal basis (required for GDPR enabled portals).
	LegalBasisExplanation *string `json:"legalBasisExplanation,omitempty"`
}

PublicUpdateSubscriptionStatusRequest A request to change the status of a contact's subscription.

func NewPublicUpdateSubscriptionStatusRequest

func NewPublicUpdateSubscriptionStatusRequest(emailAddress string, subscriptionId string) *PublicUpdateSubscriptionStatusRequest

NewPublicUpdateSubscriptionStatusRequest instantiates a new PublicUpdateSubscriptionStatusRequest 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 NewPublicUpdateSubscriptionStatusRequestWithDefaults

func NewPublicUpdateSubscriptionStatusRequestWithDefaults() *PublicUpdateSubscriptionStatusRequest

NewPublicUpdateSubscriptionStatusRequestWithDefaults instantiates a new PublicUpdateSubscriptionStatusRequest 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 (*PublicUpdateSubscriptionStatusRequest) GetEmailAddress

func (o *PublicUpdateSubscriptionStatusRequest) GetEmailAddress() string

GetEmailAddress returns the EmailAddress field value

func (*PublicUpdateSubscriptionStatusRequest) GetEmailAddressOk

func (o *PublicUpdateSubscriptionStatusRequest) GetEmailAddressOk() (*string, bool)

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

func (*PublicUpdateSubscriptionStatusRequest) GetLegalBasis

func (o *PublicUpdateSubscriptionStatusRequest) GetLegalBasis() string

GetLegalBasis returns the LegalBasis field value if set, zero value otherwise.

func (*PublicUpdateSubscriptionStatusRequest) GetLegalBasisExplanation

func (o *PublicUpdateSubscriptionStatusRequest) GetLegalBasisExplanation() string

GetLegalBasisExplanation returns the LegalBasisExplanation field value if set, zero value otherwise.

func (*PublicUpdateSubscriptionStatusRequest) GetLegalBasisExplanationOk

func (o *PublicUpdateSubscriptionStatusRequest) GetLegalBasisExplanationOk() (*string, bool)

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

func (*PublicUpdateSubscriptionStatusRequest) GetLegalBasisOk

func (o *PublicUpdateSubscriptionStatusRequest) GetLegalBasisOk() (*string, bool)

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

func (*PublicUpdateSubscriptionStatusRequest) GetSubscriptionId

func (o *PublicUpdateSubscriptionStatusRequest) GetSubscriptionId() string

GetSubscriptionId returns the SubscriptionId field value

func (*PublicUpdateSubscriptionStatusRequest) GetSubscriptionIdOk

func (o *PublicUpdateSubscriptionStatusRequest) GetSubscriptionIdOk() (*string, bool)

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

func (*PublicUpdateSubscriptionStatusRequest) HasLegalBasis

func (o *PublicUpdateSubscriptionStatusRequest) HasLegalBasis() bool

HasLegalBasis returns a boolean if a field has been set.

func (*PublicUpdateSubscriptionStatusRequest) HasLegalBasisExplanation

func (o *PublicUpdateSubscriptionStatusRequest) HasLegalBasisExplanation() bool

HasLegalBasisExplanation returns a boolean if a field has been set.

func (PublicUpdateSubscriptionStatusRequest) MarshalJSON

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

func (*PublicUpdateSubscriptionStatusRequest) SetEmailAddress

func (o *PublicUpdateSubscriptionStatusRequest) SetEmailAddress(v string)

SetEmailAddress sets field value

func (*PublicUpdateSubscriptionStatusRequest) SetLegalBasis

func (o *PublicUpdateSubscriptionStatusRequest) SetLegalBasis(v string)

SetLegalBasis gets a reference to the given string and assigns it to the LegalBasis field.

func (*PublicUpdateSubscriptionStatusRequest) SetLegalBasisExplanation

func (o *PublicUpdateSubscriptionStatusRequest) SetLegalBasisExplanation(v string)

SetLegalBasisExplanation gets a reference to the given string and assigns it to the LegalBasisExplanation field.

func (*PublicUpdateSubscriptionStatusRequest) SetSubscriptionId

func (o *PublicUpdateSubscriptionStatusRequest) SetSubscriptionId(v string)

SetSubscriptionId 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 StatusApiService

type StatusApiService service

StatusApiService StatusApi service

func (*StatusApiService) GetEmailStatus

func (a *StatusApiService) GetEmailStatus(ctx context.Context, emailAddress string) ApiGetEmailStatusRequest

GetEmailStatus Get subscription statuses for a contact

Returns a list of subscriptions and their status for a given contact.

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

func (*StatusApiService) GetEmailStatusExecute

Execute executes the request

@return PublicSubscriptionStatusesResponse

func (*StatusApiService) Subscribe

Subscribe Subscribe a contact

Subscribes a contact to the given subscription type. This API is not valid to use for subscribing a contact at a brand or portal level and will return an error.

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

func (*StatusApiService) SubscribeExecute

Execute executes the request

@return PublicSubscriptionStatus

func (*StatusApiService) Unsubscribe

Unsubscribe Unsubscribe a contact

Unsubscribes a contact from the given subscription type. This API is not valid to use for unsubscribing a contact at a brand or portal level and will return an error.

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

func (*StatusApiService) UnsubscribeExecute

Execute executes the request

@return PublicSubscriptionStatus

type SubscriptionDefinition

type SubscriptionDefinition struct {
	// A default description that is used by some HubSpot tools and cannot be edited.
	IsInternal bool `json:"isInternal"`
	// Time at which the definition was created.
	CreatedAt time.Time `json:"createdAt"`
	// A subscription definition created by HubSpot.
	IsDefault bool `json:"isDefault"`
	// The method or technology used to contact.
	CommunicationMethod *string `json:"communicationMethod,omitempty"`
	// The purpose of this subscription or the department in your organization that uses it.
	Purpose *string `json:"purpose,omitempty"`
	// The name of the subscription.
	Name string `json:"name"`
	// A description of the subscription.
	Description string `json:"description"`
	// The ID of the definition.
	Id string `json:"id"`
	// Whether the definition is active or archived.
	IsActive bool `json:"isActive"`
	// Time at which the definition was last updated.
	UpdatedAt time.Time `json:"updatedAt"`
}

SubscriptionDefinition struct for SubscriptionDefinition

func NewSubscriptionDefinition

func NewSubscriptionDefinition(isInternal bool, createdAt time.Time, isDefault bool, name string, description string, id string, isActive bool, updatedAt time.Time) *SubscriptionDefinition

NewSubscriptionDefinition instantiates a new SubscriptionDefinition 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 NewSubscriptionDefinitionWithDefaults

func NewSubscriptionDefinitionWithDefaults() *SubscriptionDefinition

NewSubscriptionDefinitionWithDefaults instantiates a new SubscriptionDefinition 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 (*SubscriptionDefinition) GetCommunicationMethod

func (o *SubscriptionDefinition) GetCommunicationMethod() string

GetCommunicationMethod returns the CommunicationMethod field value if set, zero value otherwise.

func (*SubscriptionDefinition) GetCommunicationMethodOk

func (o *SubscriptionDefinition) GetCommunicationMethodOk() (*string, bool)

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

func (*SubscriptionDefinition) GetCreatedAt

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

GetCreatedAt returns the CreatedAt field value

func (*SubscriptionDefinition) GetCreatedAtOk

func (o *SubscriptionDefinition) 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 (*SubscriptionDefinition) GetDescription

func (o *SubscriptionDefinition) GetDescription() string

GetDescription returns the Description field value

func (*SubscriptionDefinition) GetDescriptionOk

func (o *SubscriptionDefinition) GetDescriptionOk() (*string, bool)

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

func (*SubscriptionDefinition) GetId

func (o *SubscriptionDefinition) GetId() string

GetId returns the Id field value

func (*SubscriptionDefinition) GetIdOk

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

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

func (*SubscriptionDefinition) GetIsActive

func (o *SubscriptionDefinition) GetIsActive() bool

GetIsActive returns the IsActive field value

func (*SubscriptionDefinition) GetIsActiveOk

func (o *SubscriptionDefinition) GetIsActiveOk() (*bool, bool)

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

func (*SubscriptionDefinition) GetIsDefault

func (o *SubscriptionDefinition) GetIsDefault() bool

GetIsDefault returns the IsDefault field value

func (*SubscriptionDefinition) GetIsDefaultOk

func (o *SubscriptionDefinition) GetIsDefaultOk() (*bool, bool)

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

func (*SubscriptionDefinition) GetIsInternal

func (o *SubscriptionDefinition) GetIsInternal() bool

GetIsInternal returns the IsInternal field value

func (*SubscriptionDefinition) GetIsInternalOk

func (o *SubscriptionDefinition) GetIsInternalOk() (*bool, bool)

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

func (*SubscriptionDefinition) GetName

func (o *SubscriptionDefinition) GetName() string

GetName returns the Name field value

func (*SubscriptionDefinition) GetNameOk

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

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

func (*SubscriptionDefinition) GetPurpose

func (o *SubscriptionDefinition) GetPurpose() string

GetPurpose returns the Purpose field value if set, zero value otherwise.

func (*SubscriptionDefinition) GetPurposeOk

func (o *SubscriptionDefinition) GetPurposeOk() (*string, bool)

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

func (*SubscriptionDefinition) GetUpdatedAt

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

GetUpdatedAt returns the UpdatedAt field value

func (*SubscriptionDefinition) GetUpdatedAtOk

func (o *SubscriptionDefinition) 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 (*SubscriptionDefinition) HasCommunicationMethod

func (o *SubscriptionDefinition) HasCommunicationMethod() bool

HasCommunicationMethod returns a boolean if a field has been set.

func (*SubscriptionDefinition) HasPurpose

func (o *SubscriptionDefinition) HasPurpose() bool

HasPurpose returns a boolean if a field has been set.

func (SubscriptionDefinition) MarshalJSON

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

func (*SubscriptionDefinition) SetCommunicationMethod

func (o *SubscriptionDefinition) SetCommunicationMethod(v string)

SetCommunicationMethod gets a reference to the given string and assigns it to the CommunicationMethod field.

func (*SubscriptionDefinition) SetCreatedAt

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

SetCreatedAt sets field value

func (*SubscriptionDefinition) SetDescription

func (o *SubscriptionDefinition) SetDescription(v string)

SetDescription sets field value

func (*SubscriptionDefinition) SetId

func (o *SubscriptionDefinition) SetId(v string)

SetId sets field value

func (*SubscriptionDefinition) SetIsActive

func (o *SubscriptionDefinition) SetIsActive(v bool)

SetIsActive sets field value

func (*SubscriptionDefinition) SetIsDefault

func (o *SubscriptionDefinition) SetIsDefault(v bool)

SetIsDefault sets field value

func (*SubscriptionDefinition) SetIsInternal

func (o *SubscriptionDefinition) SetIsInternal(v bool)

SetIsInternal sets field value

func (*SubscriptionDefinition) SetName

func (o *SubscriptionDefinition) SetName(v string)

SetName sets field value

func (*SubscriptionDefinition) SetPurpose

func (o *SubscriptionDefinition) SetPurpose(v string)

SetPurpose gets a reference to the given string and assigns it to the Purpose field.

func (*SubscriptionDefinition) SetUpdatedAt

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

SetUpdatedAt sets field value

type SubscriptionDefinitionsResponse

type SubscriptionDefinitionsResponse struct {
	// A list of all subscription definitions.
	SubscriptionDefinitions []SubscriptionDefinition `json:"subscriptionDefinitions"`
}

SubscriptionDefinitionsResponse A collection of subscription definitions for the portal.

func NewSubscriptionDefinitionsResponse

func NewSubscriptionDefinitionsResponse(subscriptionDefinitions []SubscriptionDefinition) *SubscriptionDefinitionsResponse

NewSubscriptionDefinitionsResponse instantiates a new SubscriptionDefinitionsResponse 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 NewSubscriptionDefinitionsResponseWithDefaults

func NewSubscriptionDefinitionsResponseWithDefaults() *SubscriptionDefinitionsResponse

NewSubscriptionDefinitionsResponseWithDefaults instantiates a new SubscriptionDefinitionsResponse 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 (*SubscriptionDefinitionsResponse) GetSubscriptionDefinitions

func (o *SubscriptionDefinitionsResponse) GetSubscriptionDefinitions() []SubscriptionDefinition

GetSubscriptionDefinitions returns the SubscriptionDefinitions field value

func (*SubscriptionDefinitionsResponse) GetSubscriptionDefinitionsOk

func (o *SubscriptionDefinitionsResponse) GetSubscriptionDefinitionsOk() ([]SubscriptionDefinition, bool)

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

func (SubscriptionDefinitionsResponse) MarshalJSON

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

func (*SubscriptionDefinitionsResponse) SetSubscriptionDefinitions

func (o *SubscriptionDefinitionsResponse) SetSubscriptionDefinitions(v []SubscriptionDefinition)

SetSubscriptionDefinitions sets field value

Jump to

Keyboard shortcuts

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