schemas

package
v0.1.3 Latest Latest
Warning

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

 Go to latest Published: Apr 24, 2023 License: MIT Imports: 23 Imported by: 0

README

Go API client for schemas

The CRM uses schemas to define how custom objects should store and represent information in the HubSpot CRM. Schemas define details about an object's type, properties, and associations. The schema can be uniquely identified by its object type ID.

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 schemas "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(), schemas.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(), schemas.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(), schemas.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), schemas.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
CoreApi Archive Delete /crm/v3/schemas/{objectType} Delete a schema
CoreApi ArchiveAssociation Delete /crm/v3/schemas/{objectType}/associations/{associationIdentifier} Remove an association
CoreApi Create Post /crm/v3/schemas Create a new schema
CoreApi CreateAssociation Post /crm/v3/schemas/{objectType}/associations Create an association
CoreApi GetAll Get /crm/v3/schemas Get all schemas
CoreApi GetByID Get /crm/v3/schemas/{objectType} Get an existing schema
CoreApi Update Patch /crm/v3/schemas/{objectType} Update a schema
PublicObjectSchemasApi Purge Delete /crm/v3/schemas/{objectType}/purge

Documentation For Models

Documentation For Authorization

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.

oauth2_legacy
  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: https://app.hubspot.com/oauth/authorize
  • Scopes:
  • crm.schemas.custom.read: View custom object definitions
  • crm.objects.custom.read: View custom object records

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 {
	CoreApi *CoreApiService

	PublicObjectSchemasApi *PublicObjectSchemasApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Schemas 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 ApiArchiveAssociationRequest 

type ApiArchiveAssociationRequest struct {
	ApiService *CoreApiService
	// contains filtered or unexported fields
}

func (ApiArchiveAssociationRequest) Execute 

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

type ApiArchiveRequest 

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

func (ApiArchiveRequest) Archived 

func (r ApiArchiveRequest) Archived(archived bool) ApiArchiveRequest

Whether to return only results that have been archived.

func (ApiArchiveRequest) Execute 

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

type ApiCreateAssociationRequest 

type ApiCreateAssociationRequest struct {
	ApiService *CoreApiService
	// contains filtered or unexported fields
}

func (ApiCreateAssociationRequest) AssociationDefinitionEgg 

func (r ApiCreateAssociationRequest) AssociationDefinitionEgg(associationDefinitionEgg AssociationDefinitionEgg) ApiCreateAssociationRequest

Attributes that define the association.

func (ApiCreateAssociationRequest) Execute 

func (r ApiCreateAssociationRequest) Execute() (*AssociationDefinition, *http.Response, error)

type ApiCreateRequest 

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

func (ApiCreateRequest) Execute 

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

func (ApiCreateRequest) ObjectSchemaEgg 

func (r ApiCreateRequest) ObjectSchemaEgg(objectSchemaEgg ObjectSchemaEgg) ApiCreateRequest

Object schema definition, including properties and associations.

type ApiGetAllRequest 

type ApiGetAllRequest struct {
	ApiService *CoreApiService
	// contains filtered or unexported fields
}

func (ApiGetAllRequest) Archived 

func (r ApiGetAllRequest) Archived(archived bool) ApiGetAllRequest

Whether to return only results that have been archived.

func (ApiGetAllRequest) Execute 

func (r ApiGetAllRequest) Execute() (*CollectionResponseObjectSchemaNoPaging, *http.Response, error)

type ApiGetByIDRequest 

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

func (ApiGetByIDRequest) Execute 

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

type ApiPurgeRequest 

type ApiPurgeRequest struct {
	ApiService *PublicObjectSchemasApiService
	// contains filtered or unexported fields
}

func (ApiPurgeRequest) Execute 

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

type ApiUpdateRequest 

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

func (ApiUpdateRequest) Execute 

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

func (ApiUpdateRequest) ObjectTypeDefinitionPatch 

func (r ApiUpdateRequest) ObjectTypeDefinitionPatch(objectTypeDefinitionPatch ObjectTypeDefinitionPatch) ApiUpdateRequest

Attributes to update in your schema.

type AssociationDefinition 

type AssociationDefinition struct {
	// ID of the primary object type to link from.
	FromObjectTypeId string `json:"fromObjectTypeId"`
	// ID of the target object type ID to link to.
	ToObjectTypeId string `json:"toObjectTypeId"`
	// A unique name for this association.
	Name *string `json:"name,omitempty"`
	// A unique ID for this association.
	Id string `json:"id"`
	// When the association was defined.
	CreatedAt *time.Time `json:"createdAt,omitempty"`
	// When the association was last updated.
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
}

AssociationDefinition Defines an association between two object types.

func NewAssociationDefinition 

func NewAssociationDefinition(fromObjectTypeId string, toObjectTypeId string, id string) *AssociationDefinition

NewAssociationDefinition instantiates a new AssociationDefinition 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 NewAssociationDefinitionWithDefaults 

func NewAssociationDefinitionWithDefaults() *AssociationDefinition

NewAssociationDefinitionWithDefaults instantiates a new AssociationDefinition 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 (*AssociationDefinition) GetCreatedAt 

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

GetCreatedAt returns the CreatedAt field value if set, zero value otherwise.

func (*AssociationDefinition) GetCreatedAtOk 

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

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

func (*AssociationDefinition) GetFromObjectTypeId 

func (o *AssociationDefinition) GetFromObjectTypeId() string

GetFromObjectTypeId returns the FromObjectTypeId field value

func (*AssociationDefinition) GetFromObjectTypeIdOk 

func (o *AssociationDefinition) GetFromObjectTypeIdOk() (*string, bool)

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

func (*AssociationDefinition) GetId 

func (o *AssociationDefinition) GetId() string

GetId returns the Id field value

func (*AssociationDefinition) GetIdOk 

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

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

func (*AssociationDefinition) GetName 

func (o *AssociationDefinition) GetName() string

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

func (*AssociationDefinition) GetNameOk 

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

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

func (*AssociationDefinition) GetToObjectTypeId 

func (o *AssociationDefinition) GetToObjectTypeId() string

GetToObjectTypeId returns the ToObjectTypeId field value

func (*AssociationDefinition) GetToObjectTypeIdOk 

func (o *AssociationDefinition) GetToObjectTypeIdOk() (*string, bool)

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

func (*AssociationDefinition) GetUpdatedAt 

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

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

func (*AssociationDefinition) GetUpdatedAtOk 

func (o *AssociationDefinition) 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 (*AssociationDefinition) HasCreatedAt 

func (o *AssociationDefinition) HasCreatedAt() bool

HasCreatedAt returns a boolean if a field has been set.

func (*AssociationDefinition) HasName 

func (o *AssociationDefinition) HasName() bool

HasName returns a boolean if a field has been set.

func (*AssociationDefinition) HasUpdatedAt 

func (o *AssociationDefinition) HasUpdatedAt() bool

HasUpdatedAt returns a boolean if a field has been set.

func (AssociationDefinition) MarshalJSON 

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

func (*AssociationDefinition) SetCreatedAt 

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

SetCreatedAt gets a reference to the given time.Time and assigns it to the CreatedAt field.

func (*AssociationDefinition) SetFromObjectTypeId 

func (o *AssociationDefinition) SetFromObjectTypeId(v string)

SetFromObjectTypeId sets field value

func (*AssociationDefinition) SetId 

func (o *AssociationDefinition) SetId(v string)

SetId sets field value

func (*AssociationDefinition) SetName 

func (o *AssociationDefinition) SetName(v string)

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

func (*AssociationDefinition) SetToObjectTypeId 

func (o *AssociationDefinition) SetToObjectTypeId(v string)

SetToObjectTypeId sets field value

func (*AssociationDefinition) SetUpdatedAt 

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

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

type AssociationDefinitionEgg 

type AssociationDefinitionEgg struct {
	// ID of the primary object type to link from.
	FromObjectTypeId string `json:"fromObjectTypeId"`
	// ID of the target object type ID to link to.
	ToObjectTypeId string `json:"toObjectTypeId"`
	// A unique name for this association.
	Name *string `json:"name,omitempty"`
}

AssociationDefinitionEgg Defines an association between two object types.

func NewAssociationDefinitionEgg 

func NewAssociationDefinitionEgg(fromObjectTypeId string, toObjectTypeId string) *AssociationDefinitionEgg

NewAssociationDefinitionEgg instantiates a new AssociationDefinitionEgg 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 NewAssociationDefinitionEggWithDefaults 

func NewAssociationDefinitionEggWithDefaults() *AssociationDefinitionEgg

NewAssociationDefinitionEggWithDefaults instantiates a new AssociationDefinitionEgg 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 (*AssociationDefinitionEgg) GetFromObjectTypeId 

func (o *AssociationDefinitionEgg) GetFromObjectTypeId() string

GetFromObjectTypeId returns the FromObjectTypeId field value

func (*AssociationDefinitionEgg) GetFromObjectTypeIdOk 

func (o *AssociationDefinitionEgg) GetFromObjectTypeIdOk() (*string, bool)

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

func (*AssociationDefinitionEgg) GetName 

func (o *AssociationDefinitionEgg) GetName() string

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

func (*AssociationDefinitionEgg) GetNameOk 

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

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

func (*AssociationDefinitionEgg) GetToObjectTypeId 

func (o *AssociationDefinitionEgg) GetToObjectTypeId() string

GetToObjectTypeId returns the ToObjectTypeId field value

func (*AssociationDefinitionEgg) GetToObjectTypeIdOk 

func (o *AssociationDefinitionEgg) GetToObjectTypeIdOk() (*string, bool)

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

func (*AssociationDefinitionEgg) HasName 

func (o *AssociationDefinitionEgg) HasName() bool

HasName returns a boolean if a field has been set.

func (AssociationDefinitionEgg) MarshalJSON 

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

func (*AssociationDefinitionEgg) SetFromObjectTypeId 

func (o *AssociationDefinitionEgg) SetFromObjectTypeId(v string)

SetFromObjectTypeId sets field value

func (*AssociationDefinitionEgg) SetName 

func (o *AssociationDefinitionEgg) SetName(v string)

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

func (*AssociationDefinitionEgg) SetToObjectTypeId 

func (o *AssociationDefinitionEgg) SetToObjectTypeId(v string)

SetToObjectTypeId sets field value

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 CollectionResponseObjectSchemaNoPaging 

type CollectionResponseObjectSchemaNoPaging struct {
	Results []ObjectSchema `json:"results"`
}

CollectionResponseObjectSchemaNoPaging struct for CollectionResponseObjectSchemaNoPaging

func NewCollectionResponseObjectSchemaNoPaging 

func NewCollectionResponseObjectSchemaNoPaging(results []ObjectSchema) *CollectionResponseObjectSchemaNoPaging

NewCollectionResponseObjectSchemaNoPaging instantiates a new CollectionResponseObjectSchemaNoPaging 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 NewCollectionResponseObjectSchemaNoPagingWithDefaults 

func NewCollectionResponseObjectSchemaNoPagingWithDefaults() *CollectionResponseObjectSchemaNoPaging

NewCollectionResponseObjectSchemaNoPagingWithDefaults instantiates a new CollectionResponseObjectSchemaNoPaging 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 (*CollectionResponseObjectSchemaNoPaging) GetResults 

func (o *CollectionResponseObjectSchemaNoPaging) GetResults() []ObjectSchema

GetResults returns the Results field value

func (*CollectionResponseObjectSchemaNoPaging) GetResultsOk 

func (o *CollectionResponseObjectSchemaNoPaging) GetResultsOk() ([]ObjectSchema, bool)

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

func (CollectionResponseObjectSchemaNoPaging) MarshalJSON 

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

func (*CollectionResponseObjectSchemaNoPaging) SetResults 

func (o *CollectionResponseObjectSchemaNoPaging) SetResults(v []ObjectSchema)

SetResults 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 CoreApiService 

type CoreApiService service

CoreApiService CoreApi service

func (*CoreApiService) Archive 

func (a *CoreApiService) Archive(ctx context.Context, objectType string) ApiArchiveRequest

Archive Delete a schema

Deletes a schema. Any existing records of this schema must be deleted **first**. Otherwise this call will fail. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param objectType Fully qualified name or object type ID of your schema.
@return ApiArchiveRequest

func (*CoreApiService) ArchiveAssociation 

func (a *CoreApiService) ArchiveAssociation(ctx context.Context, objectType string, associationIdentifier string) ApiArchiveAssociationRequest

ArchiveAssociation Remove an association

Removes an existing association from a schema. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param objectType Fully qualified name or object type ID of your schema.
@param associationIdentifier Unique ID of the association to remove.
@return ApiArchiveAssociationRequest

func (*CoreApiService) ArchiveAssociationExecute 

func (a *CoreApiService) ArchiveAssociationExecute(r ApiArchiveAssociationRequest) (*http.Response, error)

Execute executes the request

func (*CoreApiService) ArchiveExecute 

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

Execute executes the request

func (*CoreApiService) Create 

func (a *CoreApiService) Create(ctx context.Context) ApiCreateRequest

Create Create a new schema

Define a new object schema, along with custom properties and associations. The entire object schema, including its object type ID, properties, and associations will be returned in the response. 

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

func (*CoreApiService) CreateAssociation 

func (a *CoreApiService) CreateAssociation(ctx context.Context, objectType string) ApiCreateAssociationRequest

CreateAssociation Create an association

Defines a new association between the primary schema's object type and other object types. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param objectType Fully qualified name or object type ID of your schema.
@return ApiCreateAssociationRequest

func (*CoreApiService) CreateAssociationExecute 

func (a *CoreApiService) CreateAssociationExecute(r ApiCreateAssociationRequest) (*AssociationDefinition, *http.Response, error)

Execute executes the request 

@return AssociationDefinition

func (*CoreApiService) CreateExecute 

func (a *CoreApiService) CreateExecute(r ApiCreateRequest) (*ObjectSchema, *http.Response, error)

Execute executes the request 

@return ObjectSchema

func (*CoreApiService) GetAll 

func (a *CoreApiService) GetAll(ctx context.Context) ApiGetAllRequest

GetAll Get all schemas

Returns all object schemas that have been defined for your account. 

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

func (*CoreApiService) GetAllExecute 

func (a *CoreApiService) GetAllExecute(r ApiGetAllRequest) (*CollectionResponseObjectSchemaNoPaging, *http.Response, error)

Execute executes the request 

@return CollectionResponseObjectSchemaNoPaging

func (*CoreApiService) GetByID 

func (a *CoreApiService) GetByID(ctx context.Context, objectType string) ApiGetByIDRequest

GetByID Get an existing schema

Returns an existing object schema. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param objectType Fully qualified name or object type ID of your schema.
@return ApiGetByIDRequest

func (*CoreApiService) GetByIDExecute 

func (a *CoreApiService) GetByIDExecute(r ApiGetByIDRequest) (*ObjectSchema, *http.Response, error)

Execute executes the request 

@return ObjectSchema

func (*CoreApiService) Update 

func (a *CoreApiService) Update(ctx context.Context, objectType string) ApiUpdateRequest

Update Update a schema

Update the details for an existing object schema. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param objectType Fully qualified name or object type ID of your schema.
@return ApiUpdateRequest

func (*CoreApiService) UpdateExecute 

func (a *CoreApiService) UpdateExecute(r ApiUpdateRequest) (*ObjectTypeDefinition, *http.Response, error)

Execute executes the request 

@return ObjectTypeDefinition

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 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 NullableAssociationDefinition 

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

func NewNullableAssociationDefinition 

func NewNullableAssociationDefinition(val *AssociationDefinition) *NullableAssociationDefinition

func (NullableAssociationDefinition) Get 

func (v NullableAssociationDefinition) Get() *AssociationDefinition

func (NullableAssociationDefinition) IsSet 

func (v NullableAssociationDefinition) IsSet() bool

func (NullableAssociationDefinition) MarshalJSON 

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

func (*NullableAssociationDefinition) Set 

func (v *NullableAssociationDefinition) Set(val *AssociationDefinition)

func (*NullableAssociationDefinition) UnmarshalJSON 

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

func (*NullableAssociationDefinition) Unset 

func (v *NullableAssociationDefinition) Unset()

type NullableAssociationDefinitionEgg 

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

func NewNullableAssociationDefinitionEgg 

func NewNullableAssociationDefinitionEgg(val *AssociationDefinitionEgg) *NullableAssociationDefinitionEgg

func (NullableAssociationDefinitionEgg) Get 

func (v NullableAssociationDefinitionEgg) Get() *AssociationDefinitionEgg

func (NullableAssociationDefinitionEgg) IsSet 

func (v NullableAssociationDefinitionEgg) IsSet() bool

func (NullableAssociationDefinitionEgg) MarshalJSON 

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

func (*NullableAssociationDefinitionEgg) Set 

func (v *NullableAssociationDefinitionEgg) Set(val *AssociationDefinitionEgg)

func (*NullableAssociationDefinitionEgg) UnmarshalJSON 

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

func (*NullableAssociationDefinitionEgg) Unset 

func (v *NullableAssociationDefinitionEgg) 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 NullableCollectionResponseObjectSchemaNoPaging 

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

func NewNullableCollectionResponseObjectSchemaNoPaging 

func NewNullableCollectionResponseObjectSchemaNoPaging(val *CollectionResponseObjectSchemaNoPaging) *NullableCollectionResponseObjectSchemaNoPaging

func (NullableCollectionResponseObjectSchemaNoPaging) Get 

func (v NullableCollectionResponseObjectSchemaNoPaging) Get() *CollectionResponseObjectSchemaNoPaging

func (NullableCollectionResponseObjectSchemaNoPaging) IsSet 

func (v NullableCollectionResponseObjectSchemaNoPaging) IsSet() bool

func (NullableCollectionResponseObjectSchemaNoPaging) MarshalJSON 

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

func (*NullableCollectionResponseObjectSchemaNoPaging) Set 

func (v *NullableCollectionResponseObjectSchemaNoPaging) Set(val *CollectionResponseObjectSchemaNoPaging)

func (*NullableCollectionResponseObjectSchemaNoPaging) UnmarshalJSON 

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

func (*NullableCollectionResponseObjectSchemaNoPaging) Unset 

func (v *NullableCollectionResponseObjectSchemaNoPaging) Unset()

type NullableError 

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

func NewNullableError 

func NewNullableError(val *Error) *NullableError

func (NullableError) Get 

func (v NullableError) Get() *Error

func (NullableError) IsSet 

func (v NullableError) IsSet() bool

func (NullableError) MarshalJSON 

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

func (*NullableError) Set 

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

func (*NullableError) UnmarshalJSON 

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

func (*NullableError) Unset 

func (v *NullableError) Unset()

type NullableErrorDetail 

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

func NewNullableErrorDetail 

func NewNullableErrorDetail(val *ErrorDetail) *NullableErrorDetail

func (NullableErrorDetail) Get 

func (v NullableErrorDetail) Get() *ErrorDetail

func (NullableErrorDetail) IsSet 

func (v NullableErrorDetail) IsSet() bool

func (NullableErrorDetail) MarshalJSON 

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

func (*NullableErrorDetail) Set 

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

func (*NullableErrorDetail) UnmarshalJSON 

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

func (*NullableErrorDetail) Unset 

func (v *NullableErrorDetail) Unset()

type NullableFloat32 

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

func NewNullableFloat32 

func NewNullableFloat32(val *float32) *NullableFloat32

func (NullableFloat32) Get 

func (v NullableFloat32) Get() *float32

func (NullableFloat32) IsSet 

func (v NullableFloat32) IsSet() bool

func (NullableFloat32) MarshalJSON 

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

func (*NullableFloat32) Set 

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

func (*NullableFloat32) UnmarshalJSON 

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

func (*NullableFloat32) Unset 

func (v *NullableFloat32) Unset()

type NullableFloat64 

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

func NewNullableFloat64 

func NewNullableFloat64(val *float64) *NullableFloat64

func (NullableFloat64) Get 

func (v NullableFloat64) Get() *float64

func (NullableFloat64) IsSet 

func (v NullableFloat64) IsSet() bool

func (NullableFloat64) MarshalJSON 

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

func (*NullableFloat64) Set 

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

func (*NullableFloat64) UnmarshalJSON 

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

func (*NullableFloat64) Unset 

func (v *NullableFloat64) Unset()

type NullableInt 

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

func NewNullableInt 

func NewNullableInt(val *int) *NullableInt

func (NullableInt) Get 

func (v NullableInt) Get() *int

func (NullableInt) IsSet 

func (v NullableInt) IsSet() bool

func (NullableInt) MarshalJSON 

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

func (*NullableInt) Set 

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

func (*NullableInt) UnmarshalJSON 

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

func (*NullableInt) Unset 

func (v *NullableInt) Unset()

type NullableInt32 

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

func NewNullableInt32 

func NewNullableInt32(val *int32) *NullableInt32

func (NullableInt32) Get 

func (v NullableInt32) Get() *int32

func (NullableInt32) IsSet 

func (v NullableInt32) IsSet() bool

func (NullableInt32) MarshalJSON 

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

func (*NullableInt32) Set 

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

func (*NullableInt32) UnmarshalJSON 

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

func (*NullableInt32) Unset 

func (v *NullableInt32) Unset()

type NullableInt64 

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

func NewNullableInt64 

func NewNullableInt64(val *int64) *NullableInt64

func (NullableInt64) Get 

func (v NullableInt64) Get() *int64

func (NullableInt64) IsSet 

func (v NullableInt64) IsSet() bool

func (NullableInt64) MarshalJSON 

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

func (*NullableInt64) Set 

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

func (*NullableInt64) UnmarshalJSON 

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

func (*NullableInt64) Unset 

func (v *NullableInt64) Unset()

type NullableObjectSchema 

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

func NewNullableObjectSchema 

func NewNullableObjectSchema(val *ObjectSchema) *NullableObjectSchema

func (NullableObjectSchema) Get 

func (v NullableObjectSchema) Get() *ObjectSchema

func (NullableObjectSchema) IsSet 

func (v NullableObjectSchema) IsSet() bool

func (NullableObjectSchema) MarshalJSON 

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

func (*NullableObjectSchema) Set 

func (v *NullableObjectSchema) Set(val *ObjectSchema)

func (*NullableObjectSchema) UnmarshalJSON 

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

func (*NullableObjectSchema) Unset 

func (v *NullableObjectSchema) Unset()

type NullableObjectSchemaEgg 

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

func NewNullableObjectSchemaEgg 

func NewNullableObjectSchemaEgg(val *ObjectSchemaEgg) *NullableObjectSchemaEgg

func (NullableObjectSchemaEgg) Get 

func (v NullableObjectSchemaEgg) Get() *ObjectSchemaEgg

func (NullableObjectSchemaEgg) IsSet 

func (v NullableObjectSchemaEgg) IsSet() bool

func (NullableObjectSchemaEgg) MarshalJSON 

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

func (*NullableObjectSchemaEgg) Set 

func (v *NullableObjectSchemaEgg) Set(val *ObjectSchemaEgg)

func (*NullableObjectSchemaEgg) UnmarshalJSON 

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

func (*NullableObjectSchemaEgg) Unset 

func (v *NullableObjectSchemaEgg) Unset()

type NullableObjectTypeDefinition 

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

func NewNullableObjectTypeDefinition 

func NewNullableObjectTypeDefinition(val *ObjectTypeDefinition) *NullableObjectTypeDefinition

func (NullableObjectTypeDefinition) Get 

func (v NullableObjectTypeDefinition) Get() *ObjectTypeDefinition

func (NullableObjectTypeDefinition) IsSet 

func (v NullableObjectTypeDefinition) IsSet() bool

func (NullableObjectTypeDefinition) MarshalJSON 

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

func (*NullableObjectTypeDefinition) Set 

func (v *NullableObjectTypeDefinition) Set(val *ObjectTypeDefinition)

func (*NullableObjectTypeDefinition) UnmarshalJSON 

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

func (*NullableObjectTypeDefinition) Unset 

func (v *NullableObjectTypeDefinition) Unset()

type NullableObjectTypeDefinitionLabels 

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

func NewNullableObjectTypeDefinitionLabels 

func NewNullableObjectTypeDefinitionLabels(val *ObjectTypeDefinitionLabels) *NullableObjectTypeDefinitionLabels

func (NullableObjectTypeDefinitionLabels) Get 

func (v NullableObjectTypeDefinitionLabels) Get() *ObjectTypeDefinitionLabels

func (NullableObjectTypeDefinitionLabels) IsSet 

func (v NullableObjectTypeDefinitionLabels) IsSet() bool

func (NullableObjectTypeDefinitionLabels) MarshalJSON 

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

func (*NullableObjectTypeDefinitionLabels) Set 

func (v *NullableObjectTypeDefinitionLabels) Set(val *ObjectTypeDefinitionLabels)

func (*NullableObjectTypeDefinitionLabels) UnmarshalJSON 

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

func (*NullableObjectTypeDefinitionLabels) Unset 

func (v *NullableObjectTypeDefinitionLabels) Unset()

type NullableObjectTypeDefinitionPatch 

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

func NewNullableObjectTypeDefinitionPatch 

func NewNullableObjectTypeDefinitionPatch(val *ObjectTypeDefinitionPatch) *NullableObjectTypeDefinitionPatch

func (NullableObjectTypeDefinitionPatch) Get 

func (v NullableObjectTypeDefinitionPatch) Get() *ObjectTypeDefinitionPatch

func (NullableObjectTypeDefinitionPatch) IsSet 

func (v NullableObjectTypeDefinitionPatch) IsSet() bool

func (NullableObjectTypeDefinitionPatch) MarshalJSON 

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

func (*NullableObjectTypeDefinitionPatch) Set 

func (v *NullableObjectTypeDefinitionPatch) Set(val *ObjectTypeDefinitionPatch)

func (*NullableObjectTypeDefinitionPatch) UnmarshalJSON 

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

func (*NullableObjectTypeDefinitionPatch) Unset 

func (v *NullableObjectTypeDefinitionPatch) Unset()

type NullableObjectTypePropertyCreate 

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

func NewNullableObjectTypePropertyCreate 

func NewNullableObjectTypePropertyCreate(val *ObjectTypePropertyCreate) *NullableObjectTypePropertyCreate

func (NullableObjectTypePropertyCreate) Get 

func (v NullableObjectTypePropertyCreate) Get() *ObjectTypePropertyCreate

func (NullableObjectTypePropertyCreate) IsSet 

func (v NullableObjectTypePropertyCreate) IsSet() bool

func (NullableObjectTypePropertyCreate) MarshalJSON 

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

func (*NullableObjectTypePropertyCreate) Set 

func (v *NullableObjectTypePropertyCreate) Set(val *ObjectTypePropertyCreate)

func (*NullableObjectTypePropertyCreate) UnmarshalJSON 

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

func (*NullableObjectTypePropertyCreate) Unset 

func (v *NullableObjectTypePropertyCreate) Unset()

type NullableOption 

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

func NewNullableOption 

func NewNullableOption(val *Option) *NullableOption

func (NullableOption) Get 

func (v NullableOption) Get() *Option

func (NullableOption) IsSet 

func (v NullableOption) IsSet() bool

func (NullableOption) MarshalJSON 

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

func (*NullableOption) Set 

func (v *NullableOption) Set(val *Option)

func (*NullableOption) UnmarshalJSON 

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

func (*NullableOption) Unset 

func (v *NullableOption) Unset()

type NullableOptionInput 

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

func NewNullableOptionInput 

func NewNullableOptionInput(val *OptionInput) *NullableOptionInput

func (NullableOptionInput) Get 

func (v NullableOptionInput) Get() *OptionInput

func (NullableOptionInput) IsSet 

func (v NullableOptionInput) IsSet() bool

func (NullableOptionInput) MarshalJSON 

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

func (*NullableOptionInput) Set 

func (v *NullableOptionInput) Set(val *OptionInput)

func (*NullableOptionInput) UnmarshalJSON 

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

func (*NullableOptionInput) Unset 

func (v *NullableOptionInput) Unset()

type NullableProperty 

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

func NewNullableProperty 

func NewNullableProperty(val *Property) *NullableProperty

func (NullableProperty) Get 

func (v NullableProperty) Get() *Property

func (NullableProperty) IsSet 

func (v NullableProperty) IsSet() bool

func (NullableProperty) MarshalJSON 

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

func (*NullableProperty) Set 

func (v *NullableProperty) Set(val *Property)

func (*NullableProperty) UnmarshalJSON 

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

func (*NullableProperty) Unset 

func (v *NullableProperty) Unset()

type NullablePropertyModificationMetadata 

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

func NewNullablePropertyModificationMetadata 

func NewNullablePropertyModificationMetadata(val *PropertyModificationMetadata) *NullablePropertyModificationMetadata

func (NullablePropertyModificationMetadata) Get 

func (v NullablePropertyModificationMetadata) Get() *PropertyModificationMetadata

func (NullablePropertyModificationMetadata) IsSet 

func (v NullablePropertyModificationMetadata) IsSet() bool

func (NullablePropertyModificationMetadata) MarshalJSON 

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

func (*NullablePropertyModificationMetadata) Set 

func (v *NullablePropertyModificationMetadata) Set(val *PropertyModificationMetadata)

func (*NullablePropertyModificationMetadata) UnmarshalJSON 

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

func (*NullablePropertyModificationMetadata) Unset 

func (v *NullablePropertyModificationMetadata) Unset()

type NullableString 

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

func NewNullableString 

func NewNullableString(val *string) *NullableString

func (NullableString) Get 

func (v NullableString) Get() *string

func (NullableString) IsSet 

func (v NullableString) IsSet() bool

func (NullableString) MarshalJSON 

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

func (*NullableString) Set 

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

func (*NullableString) UnmarshalJSON 

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

func (*NullableString) Unset 

func (v *NullableString) Unset()

type NullableTime 

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

func NewNullableTime 

func NewNullableTime(val *time.Time) *NullableTime

func (NullableTime) Get 

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

func (NullableTime) IsSet 

func (v NullableTime) IsSet() bool

func (NullableTime) MarshalJSON 

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

func (*NullableTime) Set 

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

func (*NullableTime) UnmarshalJSON 

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

func (*NullableTime) Unset 

func (v *NullableTime) Unset()

type ObjectSchema 

type ObjectSchema struct {
	Labels ObjectTypeDefinitionLabels `json:"labels"`
	// The names of properties that should be **required** when creating an object of this type.
	RequiredProperties []string `json:"requiredProperties"`
	// Names of properties that will be indexed for this object type in by HubSpot's product search.
	SearchableProperties []string `json:"searchableProperties"`
	// The name of the primary property for this object. This will be displayed as primary on the HubSpot record page for this object type.
	PrimaryDisplayProperty *string `json:"primaryDisplayProperty,omitempty"`
	// The names of secondary properties for this object. These will be displayed as secondary on the HubSpot record page for this object type.
	SecondaryDisplayProperties []string `json:"secondaryDisplayProperties"`
	Archived                   bool     `json:"archived"`
	// A unique ID for this schema's object type. Will be defined as {meta-type}-{unique ID}.
	Id string `json:"id"`
	// An assigned unique ID for the object, including portal ID and object name.
	FullyQualifiedName string `json:"fullyQualifiedName"`
	// When the object schema was created.
	CreatedAt *time.Time `json:"createdAt,omitempty"`
	// When the object schema was last updated.
	UpdatedAt    *time.Time `json:"updatedAt,omitempty"`
	ObjectTypeId string     `json:"objectTypeId"`
	// Properties defined for this object type.
	Properties []Property `json:"properties"`
	// Associations defined for a given object type.
	Associations []AssociationDefinition `json:"associations"`
	// A unique name for the schema's object type.
	Name string `json:"name"`
}

ObjectSchema Defines an object schema, including its properties and associations.

func NewObjectSchema 

func NewObjectSchema(labels ObjectTypeDefinitionLabels, requiredProperties []string, searchableProperties []string, secondaryDisplayProperties []string, archived bool, id string, fullyQualifiedName string, objectTypeId string, properties []Property, associations []AssociationDefinition, name string) *ObjectSchema

NewObjectSchema instantiates a new ObjectSchema 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 NewObjectSchemaWithDefaults 

func NewObjectSchemaWithDefaults() *ObjectSchema

NewObjectSchemaWithDefaults instantiates a new ObjectSchema 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 (*ObjectSchema) GetArchived 

func (o *ObjectSchema) GetArchived() bool

GetArchived returns the Archived field value

func (*ObjectSchema) GetArchivedOk 

func (o *ObjectSchema) GetArchivedOk() (*bool, bool)

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

func (*ObjectSchema) GetAssociations 

func (o *ObjectSchema) GetAssociations() []AssociationDefinition

GetAssociations returns the Associations field value

func (*ObjectSchema) GetAssociationsOk 

func (o *ObjectSchema) GetAssociationsOk() ([]AssociationDefinition, bool)

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

func (*ObjectSchema) GetCreatedAt 

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

GetCreatedAt returns the CreatedAt field value if set, zero value otherwise.

func (*ObjectSchema) GetCreatedAtOk 

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

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

func (*ObjectSchema) GetFullyQualifiedName 

func (o *ObjectSchema) GetFullyQualifiedName() string

GetFullyQualifiedName returns the FullyQualifiedName field value

func (*ObjectSchema) GetFullyQualifiedNameOk 

func (o *ObjectSchema) GetFullyQualifiedNameOk() (*string, bool)

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

func (*ObjectSchema) GetId 

func (o *ObjectSchema) GetId() string

GetId returns the Id field value

func (*ObjectSchema) GetIdOk 

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

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

func (*ObjectSchema) GetLabels 

func (o *ObjectSchema) GetLabels() ObjectTypeDefinitionLabels

GetLabels returns the Labels field value

func (*ObjectSchema) GetLabelsOk 

func (o *ObjectSchema) GetLabelsOk() (*ObjectTypeDefinitionLabels, bool)

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

func (*ObjectSchema) GetName 

func (o *ObjectSchema) GetName() string

GetName returns the Name field value

func (*ObjectSchema) GetNameOk 

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

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

func (*ObjectSchema) GetObjectTypeId 

func (o *ObjectSchema) GetObjectTypeId() string

GetObjectTypeId returns the ObjectTypeId field value

func (*ObjectSchema) GetObjectTypeIdOk 

func (o *ObjectSchema) GetObjectTypeIdOk() (*string, bool)

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

func (*ObjectSchema) GetPrimaryDisplayProperty 

func (o *ObjectSchema) GetPrimaryDisplayProperty() string

GetPrimaryDisplayProperty returns the PrimaryDisplayProperty field value if set, zero value otherwise.

func (*ObjectSchema) GetPrimaryDisplayPropertyOk 

func (o *ObjectSchema) GetPrimaryDisplayPropertyOk() (*string, bool)

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

func (*ObjectSchema) GetProperties 

func (o *ObjectSchema) GetProperties() []Property

GetProperties returns the Properties field value

func (*ObjectSchema) GetPropertiesOk 

func (o *ObjectSchema) GetPropertiesOk() ([]Property, bool)

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

func (*ObjectSchema) GetRequiredProperties 

func (o *ObjectSchema) GetRequiredProperties() []string

GetRequiredProperties returns the RequiredProperties field value

func (*ObjectSchema) GetRequiredPropertiesOk 

func (o *ObjectSchema) GetRequiredPropertiesOk() ([]string, bool)

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

func (*ObjectSchema) GetSearchableProperties 

func (o *ObjectSchema) GetSearchableProperties() []string

GetSearchableProperties returns the SearchableProperties field value

func (*ObjectSchema) GetSearchablePropertiesOk 

func (o *ObjectSchema) GetSearchablePropertiesOk() ([]string, bool)

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

func (*ObjectSchema) GetSecondaryDisplayProperties 

func (o *ObjectSchema) GetSecondaryDisplayProperties() []string

GetSecondaryDisplayProperties returns the SecondaryDisplayProperties field value

func (*ObjectSchema) GetSecondaryDisplayPropertiesOk 

func (o *ObjectSchema) GetSecondaryDisplayPropertiesOk() ([]string, bool)

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

func (*ObjectSchema) GetUpdatedAt 

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

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

func (*ObjectSchema) GetUpdatedAtOk 

func (o *ObjectSchema) 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 (*ObjectSchema) HasCreatedAt 

func (o *ObjectSchema) HasCreatedAt() bool

HasCreatedAt returns a boolean if a field has been set.

func (*ObjectSchema) HasPrimaryDisplayProperty 

func (o *ObjectSchema) HasPrimaryDisplayProperty() bool

HasPrimaryDisplayProperty returns a boolean if a field has been set.

func (*ObjectSchema) HasUpdatedAt 

func (o *ObjectSchema) HasUpdatedAt() bool

HasUpdatedAt returns a boolean if a field has been set.

func (ObjectSchema) MarshalJSON 

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

func (*ObjectSchema) SetArchived 

func (o *ObjectSchema) SetArchived(v bool)

SetArchived sets field value

func (*ObjectSchema) SetAssociations 

func (o *ObjectSchema) SetAssociations(v []AssociationDefinition)

SetAssociations sets field value

func (*ObjectSchema) SetCreatedAt 

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

SetCreatedAt gets a reference to the given time.Time and assigns it to the CreatedAt field.

func (*ObjectSchema) SetFullyQualifiedName 

func (o *ObjectSchema) SetFullyQualifiedName(v string)

SetFullyQualifiedName sets field value

func (*ObjectSchema) SetId 

func (o *ObjectSchema) SetId(v string)

SetId sets field value

func (*ObjectSchema) SetLabels 

func (o *ObjectSchema) SetLabels(v ObjectTypeDefinitionLabels)

SetLabels sets field value

func (*ObjectSchema) SetName 

func (o *ObjectSchema) SetName(v string)

SetName sets field value

func (*ObjectSchema) SetObjectTypeId 

func (o *ObjectSchema) SetObjectTypeId(v string)

SetObjectTypeId sets field value

func (*ObjectSchema) SetPrimaryDisplayProperty 

func (o *ObjectSchema) SetPrimaryDisplayProperty(v string)

SetPrimaryDisplayProperty gets a reference to the given string and assigns it to the PrimaryDisplayProperty field.

func (*ObjectSchema) SetProperties 

func (o *ObjectSchema) SetProperties(v []Property)

SetProperties sets field value

func (*ObjectSchema) SetRequiredProperties 

func (o *ObjectSchema) SetRequiredProperties(v []string)

SetRequiredProperties sets field value

func (*ObjectSchema) SetSearchableProperties 

func (o *ObjectSchema) SetSearchableProperties(v []string)

SetSearchableProperties sets field value

func (*ObjectSchema) SetSecondaryDisplayProperties 

func (o *ObjectSchema) SetSecondaryDisplayProperties(v []string)

SetSecondaryDisplayProperties sets field value

func (*ObjectSchema) SetUpdatedAt 

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

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

type ObjectSchemaEgg 

type ObjectSchemaEgg struct {
	Labels ObjectTypeDefinitionLabels `json:"labels"`
	// The names of properties that should be **required** when creating an object of this type.
	RequiredProperties []string `json:"requiredProperties"`
	// Names of properties that will be indexed for this object type in by HubSpot's product search.
	SearchableProperties []string `json:"searchableProperties"`
	// The name of the primary property for this object. This will be displayed as primary on the HubSpot record page for this object type.
	PrimaryDisplayProperty *string `json:"primaryDisplayProperty,omitempty"`
	// The names of secondary properties for this object. These will be displayed as secondary on the HubSpot record page for this object type.
	SecondaryDisplayProperties []string `json:"secondaryDisplayProperties"`
	// Properties defined for this object type.
	Properties []ObjectTypePropertyCreate `json:"properties"`
	// Associations defined for this object type.
	AssociatedObjects []string `json:"associatedObjects"`
	// A unique name for this object. For internal use only.
	Name string `json:"name"`
}

ObjectSchemaEgg Defines a new object type, its properties, and associations.

func NewObjectSchemaEgg 

func NewObjectSchemaEgg(labels ObjectTypeDefinitionLabels, requiredProperties []string, searchableProperties []string, secondaryDisplayProperties []string, properties []ObjectTypePropertyCreate, associatedObjects []string, name string) *ObjectSchemaEgg

NewObjectSchemaEgg instantiates a new ObjectSchemaEgg 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 NewObjectSchemaEggWithDefaults 

func NewObjectSchemaEggWithDefaults() *ObjectSchemaEgg

NewObjectSchemaEggWithDefaults instantiates a new ObjectSchemaEgg 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 (*ObjectSchemaEgg) GetAssociatedObjects 

func (o *ObjectSchemaEgg) GetAssociatedObjects() []string

GetAssociatedObjects returns the AssociatedObjects field value

func (*ObjectSchemaEgg) GetAssociatedObjectsOk 

func (o *ObjectSchemaEgg) GetAssociatedObjectsOk() ([]string, bool)

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

func (*ObjectSchemaEgg) GetLabels 

func (o *ObjectSchemaEgg) GetLabels() ObjectTypeDefinitionLabels

GetLabels returns the Labels field value

func (*ObjectSchemaEgg) GetLabelsOk 

func (o *ObjectSchemaEgg) GetLabelsOk() (*ObjectTypeDefinitionLabels, bool)

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

func (*ObjectSchemaEgg) GetName 

func (o *ObjectSchemaEgg) GetName() string

GetName returns the Name field value

func (*ObjectSchemaEgg) GetNameOk 

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

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

func (*ObjectSchemaEgg) GetPrimaryDisplayProperty 

func (o *ObjectSchemaEgg) GetPrimaryDisplayProperty() string

GetPrimaryDisplayProperty returns the PrimaryDisplayProperty field value if set, zero value otherwise.

func (*ObjectSchemaEgg) GetPrimaryDisplayPropertyOk 

func (o *ObjectSchemaEgg) GetPrimaryDisplayPropertyOk() (*string, bool)

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

func (*ObjectSchemaEgg) GetProperties 

func (o *ObjectSchemaEgg) GetProperties() []ObjectTypePropertyCreate

GetProperties returns the Properties field value

func (*ObjectSchemaEgg) GetPropertiesOk 

func (o *ObjectSchemaEgg) GetPropertiesOk() ([]ObjectTypePropertyCreate, bool)

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

func (*ObjectSchemaEgg) GetRequiredProperties 

func (o *ObjectSchemaEgg) GetRequiredProperties() []string

GetRequiredProperties returns the RequiredProperties field value

func (*ObjectSchemaEgg) GetRequiredPropertiesOk 

func (o *ObjectSchemaEgg) GetRequiredPropertiesOk() ([]string, bool)

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

func (*ObjectSchemaEgg) GetSearchableProperties 

func (o *ObjectSchemaEgg) GetSearchableProperties() []string

GetSearchableProperties returns the SearchableProperties field value

func (*ObjectSchemaEgg) GetSearchablePropertiesOk 

func (o *ObjectSchemaEgg) GetSearchablePropertiesOk() ([]string, bool)

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

func (*ObjectSchemaEgg) GetSecondaryDisplayProperties 

func (o *ObjectSchemaEgg) GetSecondaryDisplayProperties() []string

GetSecondaryDisplayProperties returns the SecondaryDisplayProperties field value

func (*ObjectSchemaEgg) GetSecondaryDisplayPropertiesOk 

func (o *ObjectSchemaEgg) GetSecondaryDisplayPropertiesOk() ([]string, bool)

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

func (*ObjectSchemaEgg) HasPrimaryDisplayProperty 

func (o *ObjectSchemaEgg) HasPrimaryDisplayProperty() bool

HasPrimaryDisplayProperty returns a boolean if a field has been set.

func (ObjectSchemaEgg) MarshalJSON 

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

func (*ObjectSchemaEgg) SetAssociatedObjects 

func (o *ObjectSchemaEgg) SetAssociatedObjects(v []string)

SetAssociatedObjects sets field value

func (*ObjectSchemaEgg) SetLabels 

func (o *ObjectSchemaEgg) SetLabels(v ObjectTypeDefinitionLabels)

SetLabels sets field value

func (*ObjectSchemaEgg) SetName 

func (o *ObjectSchemaEgg) SetName(v string)

SetName sets field value

func (*ObjectSchemaEgg) SetPrimaryDisplayProperty 

func (o *ObjectSchemaEgg) SetPrimaryDisplayProperty(v string)

SetPrimaryDisplayProperty gets a reference to the given string and assigns it to the PrimaryDisplayProperty field.

func (*ObjectSchemaEgg) SetProperties 

func (o *ObjectSchemaEgg) SetProperties(v []ObjectTypePropertyCreate)

SetProperties sets field value

func (*ObjectSchemaEgg) SetRequiredProperties 

func (o *ObjectSchemaEgg) SetRequiredProperties(v []string)

SetRequiredProperties sets field value

func (*ObjectSchemaEgg) SetSearchableProperties 

func (o *ObjectSchemaEgg) SetSearchableProperties(v []string)

SetSearchableProperties sets field value

func (*ObjectSchemaEgg) SetSecondaryDisplayProperties 

func (o *ObjectSchemaEgg) SetSecondaryDisplayProperties(v []string)

SetSecondaryDisplayProperties sets field value

type ObjectTypeDefinition 

type ObjectTypeDefinition struct {
	Labels ObjectTypeDefinitionLabels `json:"labels"`
	// The names of properties that should be **required** when creating an object of this type.
	RequiredProperties []string `json:"requiredProperties"`
	// Names of properties that will be indexed for this object type in by HubSpot's product search.
	SearchableProperties []string `json:"searchableProperties"`
	// The name of the primary property for this object. This will be displayed as primary on the HubSpot record page for this object type.
	PrimaryDisplayProperty *string `json:"primaryDisplayProperty,omitempty"`
	// The names of secondary properties for this object. These will be displayed as secondary on the HubSpot record page for this object type.
	SecondaryDisplayProperties []string `json:"secondaryDisplayProperties"`
	Archived                   bool     `json:"archived"`
	// A unique ID for this object type. Will be defined as {meta-type}-{unique ID}.
	Id                 string `json:"id"`
	FullyQualifiedName string `json:"fullyQualifiedName"`
	// When the object type was created.
	CreatedAt *time.Time `json:"createdAt,omitempty"`
	// When the object type was last updated.
	UpdatedAt    *time.Time `json:"updatedAt,omitempty"`
	ObjectTypeId string     `json:"objectTypeId"`
	// A unique name for this object. For internal use only.
	Name string `json:"name"`
	// The ID of the account that this object type is specific to.
	PortalId *int32 `json:"portalId,omitempty"`
}

ObjectTypeDefinition Defines an object type.

func NewObjectTypeDefinition 

func NewObjectTypeDefinition(labels ObjectTypeDefinitionLabels, requiredProperties []string, searchableProperties []string, secondaryDisplayProperties []string, archived bool, id string, fullyQualifiedName string, objectTypeId string, name string) *ObjectTypeDefinition

NewObjectTypeDefinition instantiates a new ObjectTypeDefinition 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 NewObjectTypeDefinitionWithDefaults 

func NewObjectTypeDefinitionWithDefaults() *ObjectTypeDefinition

NewObjectTypeDefinitionWithDefaults instantiates a new ObjectTypeDefinition 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 (*ObjectTypeDefinition) GetArchived 

func (o *ObjectTypeDefinition) GetArchived() bool

GetArchived returns the Archived field value

func (*ObjectTypeDefinition) GetArchivedOk 

func (o *ObjectTypeDefinition) GetArchivedOk() (*bool, bool)

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

func (*ObjectTypeDefinition) GetCreatedAt 

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

GetCreatedAt returns the CreatedAt field value if set, zero value otherwise.

func (*ObjectTypeDefinition) GetCreatedAtOk 

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

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

func (*ObjectTypeDefinition) GetFullyQualifiedName 

func (o *ObjectTypeDefinition) GetFullyQualifiedName() string

GetFullyQualifiedName returns the FullyQualifiedName field value

func (*ObjectTypeDefinition) GetFullyQualifiedNameOk 

func (o *ObjectTypeDefinition) GetFullyQualifiedNameOk() (*string, bool)

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

func (*ObjectTypeDefinition) GetId 

func (o *ObjectTypeDefinition) GetId() string

GetId returns the Id field value

func (*ObjectTypeDefinition) GetIdOk 

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

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

func (*ObjectTypeDefinition) GetLabels 

func (o *ObjectTypeDefinition) GetLabels() ObjectTypeDefinitionLabels

GetLabels returns the Labels field value

func (*ObjectTypeDefinition) GetLabelsOk 

func (o *ObjectTypeDefinition) GetLabelsOk() (*ObjectTypeDefinitionLabels, bool)

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

func (*ObjectTypeDefinition) GetName 

func (o *ObjectTypeDefinition) GetName() string

GetName returns the Name field value

func (*ObjectTypeDefinition) GetNameOk 

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

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

func (*ObjectTypeDefinition) GetObjectTypeId 

func (o *ObjectTypeDefinition) GetObjectTypeId() string

GetObjectTypeId returns the ObjectTypeId field value

func (*ObjectTypeDefinition) GetObjectTypeIdOk 

func (o *ObjectTypeDefinition) GetObjectTypeIdOk() (*string, bool)

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

func (*ObjectTypeDefinition) GetPortalId 

func (o *ObjectTypeDefinition) GetPortalId() int32

GetPortalId returns the PortalId field value if set, zero value otherwise.

func (*ObjectTypeDefinition) GetPortalIdOk 

func (o *ObjectTypeDefinition) GetPortalIdOk() (*int32, bool)

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

func (*ObjectTypeDefinition) GetPrimaryDisplayProperty 

func (o *ObjectTypeDefinition) GetPrimaryDisplayProperty() string

GetPrimaryDisplayProperty returns the PrimaryDisplayProperty field value if set, zero value otherwise.

func (*ObjectTypeDefinition) GetPrimaryDisplayPropertyOk 

func (o *ObjectTypeDefinition) GetPrimaryDisplayPropertyOk() (*string, bool)

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

func (*ObjectTypeDefinition) GetRequiredProperties 

func (o *ObjectTypeDefinition) GetRequiredProperties() []string

GetRequiredProperties returns the RequiredProperties field value

func (*ObjectTypeDefinition) GetRequiredPropertiesOk 

func (o *ObjectTypeDefinition) GetRequiredPropertiesOk() ([]string, bool)

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

func (*ObjectTypeDefinition) GetSearchableProperties 

func (o *ObjectTypeDefinition) GetSearchableProperties() []string

GetSearchableProperties returns the SearchableProperties field value

func (*ObjectTypeDefinition) GetSearchablePropertiesOk 

func (o *ObjectTypeDefinition) GetSearchablePropertiesOk() ([]string, bool)

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

func (*ObjectTypeDefinition) GetSecondaryDisplayProperties 

func (o *ObjectTypeDefinition) GetSecondaryDisplayProperties() []string

GetSecondaryDisplayProperties returns the SecondaryDisplayProperties field value

func (*ObjectTypeDefinition) GetSecondaryDisplayPropertiesOk 

func (o *ObjectTypeDefinition) GetSecondaryDisplayPropertiesOk() ([]string, bool)

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

func (*ObjectTypeDefinition) GetUpdatedAt 

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

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

func (*ObjectTypeDefinition) GetUpdatedAtOk 

func (o *ObjectTypeDefinition) 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 (*ObjectTypeDefinition) HasCreatedAt 

func (o *ObjectTypeDefinition) HasCreatedAt() bool

HasCreatedAt returns a boolean if a field has been set.

func (*ObjectTypeDefinition) HasPortalId 

func (o *ObjectTypeDefinition) HasPortalId() bool

HasPortalId returns a boolean if a field has been set.

func (*ObjectTypeDefinition) HasPrimaryDisplayProperty 

func (o *ObjectTypeDefinition) HasPrimaryDisplayProperty() bool

HasPrimaryDisplayProperty returns a boolean if a field has been set.

func (*ObjectTypeDefinition) HasUpdatedAt 

func (o *ObjectTypeDefinition) HasUpdatedAt() bool

HasUpdatedAt returns a boolean if a field has been set.

func (ObjectTypeDefinition) MarshalJSON 

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

func (*ObjectTypeDefinition) SetArchived 

func (o *ObjectTypeDefinition) SetArchived(v bool)

SetArchived sets field value

func (*ObjectTypeDefinition) SetCreatedAt 

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

SetCreatedAt gets a reference to the given time.Time and assigns it to the CreatedAt field.

func (*ObjectTypeDefinition) SetFullyQualifiedName 

func (o *ObjectTypeDefinition) SetFullyQualifiedName(v string)

SetFullyQualifiedName sets field value

func (*ObjectTypeDefinition) SetId 

func (o *ObjectTypeDefinition) SetId(v string)

SetId sets field value

func (*ObjectTypeDefinition) SetLabels 

func (o *ObjectTypeDefinition) SetLabels(v ObjectTypeDefinitionLabels)

SetLabels sets field value

func (*ObjectTypeDefinition) SetName 

func (o *ObjectTypeDefinition) SetName(v string)

SetName sets field value

func (*ObjectTypeDefinition) SetObjectTypeId 

func (o *ObjectTypeDefinition) SetObjectTypeId(v string)

SetObjectTypeId sets field value

func (*ObjectTypeDefinition) SetPortalId 

func (o *ObjectTypeDefinition) SetPortalId(v int32)

SetPortalId gets a reference to the given int32 and assigns it to the PortalId field.

func (*ObjectTypeDefinition) SetPrimaryDisplayProperty 

func (o *ObjectTypeDefinition) SetPrimaryDisplayProperty(v string)

SetPrimaryDisplayProperty gets a reference to the given string and assigns it to the PrimaryDisplayProperty field.

func (*ObjectTypeDefinition) SetRequiredProperties 

func (o *ObjectTypeDefinition) SetRequiredProperties(v []string)

SetRequiredProperties sets field value

func (*ObjectTypeDefinition) SetSearchableProperties 

func (o *ObjectTypeDefinition) SetSearchableProperties(v []string)

SetSearchableProperties sets field value

func (*ObjectTypeDefinition) SetSecondaryDisplayProperties 

func (o *ObjectTypeDefinition) SetSecondaryDisplayProperties(v []string)

SetSecondaryDisplayProperties sets field value

func (*ObjectTypeDefinition) SetUpdatedAt 

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

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

type ObjectTypeDefinitionLabels 

type ObjectTypeDefinitionLabels struct {
	// The word for one object. (There’s no way to change this later.)
	Singular *string `json:"singular,omitempty"`
	// The word for multiple objects. (There’s no way to change this later.)
	Plural *string `json:"plural,omitempty"`
}

ObjectTypeDefinitionLabels Singular and plural labels for the object. Used in CRM display.

func NewObjectTypeDefinitionLabels 

func NewObjectTypeDefinitionLabels() *ObjectTypeDefinitionLabels

NewObjectTypeDefinitionLabels instantiates a new ObjectTypeDefinitionLabels 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 NewObjectTypeDefinitionLabelsWithDefaults 

func NewObjectTypeDefinitionLabelsWithDefaults() *ObjectTypeDefinitionLabels

NewObjectTypeDefinitionLabelsWithDefaults instantiates a new ObjectTypeDefinitionLabels 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 (*ObjectTypeDefinitionLabels) GetPlural 

func (o *ObjectTypeDefinitionLabels) GetPlural() string

GetPlural returns the Plural field value if set, zero value otherwise.

func (*ObjectTypeDefinitionLabels) GetPluralOk 

func (o *ObjectTypeDefinitionLabels) GetPluralOk() (*string, bool)

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

func (*ObjectTypeDefinitionLabels) GetSingular 

func (o *ObjectTypeDefinitionLabels) GetSingular() string

GetSingular returns the Singular field value if set, zero value otherwise.

func (*ObjectTypeDefinitionLabels) GetSingularOk 

func (o *ObjectTypeDefinitionLabels) GetSingularOk() (*string, bool)

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

func (*ObjectTypeDefinitionLabels) HasPlural 

func (o *ObjectTypeDefinitionLabels) HasPlural() bool

HasPlural returns a boolean if a field has been set.

func (*ObjectTypeDefinitionLabels) HasSingular 

func (o *ObjectTypeDefinitionLabels) HasSingular() bool

HasSingular returns a boolean if a field has been set.

func (ObjectTypeDefinitionLabels) MarshalJSON 

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

func (*ObjectTypeDefinitionLabels) SetPlural 

func (o *ObjectTypeDefinitionLabels) SetPlural(v string)

SetPlural gets a reference to the given string and assigns it to the Plural field.

func (*ObjectTypeDefinitionLabels) SetSingular 

func (o *ObjectTypeDefinitionLabels) SetSingular(v string)

SetSingular gets a reference to the given string and assigns it to the Singular field.

type ObjectTypeDefinitionPatch 

type ObjectTypeDefinitionPatch struct {
	Labels *ObjectTypeDefinitionLabels `json:"labels,omitempty"`
	// The names of properties that should be **required** when creating an object of this type.
	RequiredProperties []string `json:"requiredProperties,omitempty"`
	// Names of properties that will be indexed for this object type in by HubSpot's product search.
	SearchableProperties []string `json:"searchableProperties,omitempty"`
	// The name of the primary property for this object. This will be displayed as primary on the HubSpot record page for this object type.
	PrimaryDisplayProperty *string `json:"primaryDisplayProperty,omitempty"`
	// The names of secondary properties for this object. These will be displayed as secondary on the HubSpot record page for this object type.
	SecondaryDisplayProperties []string `json:"secondaryDisplayProperties,omitempty"`
	Restorable                 *bool    `json:"restorable,omitempty"`
}

ObjectTypeDefinitionPatch Defines attributes to update on an object type.

func NewObjectTypeDefinitionPatch 

func NewObjectTypeDefinitionPatch() *ObjectTypeDefinitionPatch

NewObjectTypeDefinitionPatch instantiates a new ObjectTypeDefinitionPatch 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 NewObjectTypeDefinitionPatchWithDefaults 

func NewObjectTypeDefinitionPatchWithDefaults() *ObjectTypeDefinitionPatch

NewObjectTypeDefinitionPatchWithDefaults instantiates a new ObjectTypeDefinitionPatch 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 (*ObjectTypeDefinitionPatch) GetLabels 

func (o *ObjectTypeDefinitionPatch) GetLabels() ObjectTypeDefinitionLabels

GetLabels returns the Labels field value if set, zero value otherwise.

func (*ObjectTypeDefinitionPatch) GetLabelsOk 

func (o *ObjectTypeDefinitionPatch) GetLabelsOk() (*ObjectTypeDefinitionLabels, bool)

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

func (*ObjectTypeDefinitionPatch) GetPrimaryDisplayProperty 

func (o *ObjectTypeDefinitionPatch) GetPrimaryDisplayProperty() string

GetPrimaryDisplayProperty returns the PrimaryDisplayProperty field value if set, zero value otherwise.

func (*ObjectTypeDefinitionPatch) GetPrimaryDisplayPropertyOk 

func (o *ObjectTypeDefinitionPatch) GetPrimaryDisplayPropertyOk() (*string, bool)

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

func (*ObjectTypeDefinitionPatch) GetRequiredProperties 

func (o *ObjectTypeDefinitionPatch) GetRequiredProperties() []string

GetRequiredProperties returns the RequiredProperties field value if set, zero value otherwise.

func (*ObjectTypeDefinitionPatch) GetRequiredPropertiesOk 

func (o *ObjectTypeDefinitionPatch) GetRequiredPropertiesOk() ([]string, bool)

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

func (*ObjectTypeDefinitionPatch) GetRestorable 

func (o *ObjectTypeDefinitionPatch) GetRestorable() bool

GetRestorable returns the Restorable field value if set, zero value otherwise.

func (*ObjectTypeDefinitionPatch) GetRestorableOk 

func (o *ObjectTypeDefinitionPatch) GetRestorableOk() (*bool, bool)

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

func (*ObjectTypeDefinitionPatch) GetSearchableProperties 

func (o *ObjectTypeDefinitionPatch) GetSearchableProperties() []string

GetSearchableProperties returns the SearchableProperties field value if set, zero value otherwise.

func (*ObjectTypeDefinitionPatch) GetSearchablePropertiesOk 

func (o *ObjectTypeDefinitionPatch) GetSearchablePropertiesOk() ([]string, bool)

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

func (*ObjectTypeDefinitionPatch) GetSecondaryDisplayProperties 

func (o *ObjectTypeDefinitionPatch) GetSecondaryDisplayProperties() []string

GetSecondaryDisplayProperties returns the SecondaryDisplayProperties field value if set, zero value otherwise.

func (*ObjectTypeDefinitionPatch) GetSecondaryDisplayPropertiesOk 

func (o *ObjectTypeDefinitionPatch) GetSecondaryDisplayPropertiesOk() ([]string, bool)

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

func (*ObjectTypeDefinitionPatch) HasLabels 

func (o *ObjectTypeDefinitionPatch) HasLabels() bool

HasLabels returns a boolean if a field has been set.

func (*ObjectTypeDefinitionPatch) HasPrimaryDisplayProperty 

func (o *ObjectTypeDefinitionPatch) HasPrimaryDisplayProperty() bool

HasPrimaryDisplayProperty returns a boolean if a field has been set.

func (*ObjectTypeDefinitionPatch) HasRequiredProperties 

func (o *ObjectTypeDefinitionPatch) HasRequiredProperties() bool

HasRequiredProperties returns a boolean if a field has been set.

func (*ObjectTypeDefinitionPatch) HasRestorable 

func (o *ObjectTypeDefinitionPatch) HasRestorable() bool

HasRestorable returns a boolean if a field has been set.

func (*ObjectTypeDefinitionPatch) HasSearchableProperties 

func (o *ObjectTypeDefinitionPatch) HasSearchableProperties() bool

HasSearchableProperties returns a boolean if a field has been set.

func (*ObjectTypeDefinitionPatch) HasSecondaryDisplayProperties 

func (o *ObjectTypeDefinitionPatch) HasSecondaryDisplayProperties() bool

HasSecondaryDisplayProperties returns a boolean if a field has been set.

func (ObjectTypeDefinitionPatch) MarshalJSON 

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

func (*ObjectTypeDefinitionPatch) SetLabels 

func (o *ObjectTypeDefinitionPatch) SetLabels(v ObjectTypeDefinitionLabels)

SetLabels gets a reference to the given ObjectTypeDefinitionLabels and assigns it to the Labels field.

func (*ObjectTypeDefinitionPatch) SetPrimaryDisplayProperty 

func (o *ObjectTypeDefinitionPatch) SetPrimaryDisplayProperty(v string)

SetPrimaryDisplayProperty gets a reference to the given string and assigns it to the PrimaryDisplayProperty field.

func (*ObjectTypeDefinitionPatch) SetRequiredProperties 

func (o *ObjectTypeDefinitionPatch) SetRequiredProperties(v []string)

SetRequiredProperties gets a reference to the given []string and assigns it to the RequiredProperties field.

func (*ObjectTypeDefinitionPatch) SetRestorable 

func (o *ObjectTypeDefinitionPatch) SetRestorable(v bool)

SetRestorable gets a reference to the given bool and assigns it to the Restorable field.

func (*ObjectTypeDefinitionPatch) SetSearchableProperties 

func (o *ObjectTypeDefinitionPatch) SetSearchableProperties(v []string)

SetSearchableProperties gets a reference to the given []string and assigns it to the SearchableProperties field.

func (*ObjectTypeDefinitionPatch) SetSecondaryDisplayProperties 

func (o *ObjectTypeDefinitionPatch) SetSecondaryDisplayProperties(v []string)

SetSecondaryDisplayProperties gets a reference to the given []string and assigns it to the SecondaryDisplayProperties field.

type ObjectTypePropertyCreate 

type ObjectTypePropertyCreate struct {
	// The internal property name, which must be used when referencing the property from the API.
	Name string `json:"name"`
	// A human-readable property label that will be shown in HubSpot.
	Label string `json:"label"`
	// The name of the group this property belongs to.
	GroupName *string `json:"groupName,omitempty"`
	// A description of the property that will be shown as help text in HubSpot.
	Description *string `json:"description,omitempty"`
	// A list of available options for the property. This field is only required for enumerated properties.
	Options []OptionInput `json:"options,omitempty"`
	// The order that this property should be displayed in the HubSpot UI relative to other properties for this object type. Properties are displayed in order starting with the lowest positive integer value. A value of -1 will cause the property to be displayed **after** any positive values.
	DisplayOrder *int32 `json:"displayOrder,omitempty"`
	// Whether or not the property's value must be unique. Once set, this can't be changed.
	HasUniqueValue *bool `json:"hasUniqueValue,omitempty"`
	Hidden         *bool `json:"hidden,omitempty"`
	// The data type of the property.
	Type string `json:"type"`
	// Controls how the property appears in HubSpot.
	FieldType string `json:"fieldType"`
}

ObjectTypePropertyCreate Defines a property to create.

func NewObjectTypePropertyCreate 

func NewObjectTypePropertyCreate(name string, label string, type_ string, fieldType string) *ObjectTypePropertyCreate

NewObjectTypePropertyCreate instantiates a new ObjectTypePropertyCreate 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 NewObjectTypePropertyCreateWithDefaults 

func NewObjectTypePropertyCreateWithDefaults() *ObjectTypePropertyCreate

NewObjectTypePropertyCreateWithDefaults instantiates a new ObjectTypePropertyCreate 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 (*ObjectTypePropertyCreate) GetDescription 

func (o *ObjectTypePropertyCreate) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise.

func (*ObjectTypePropertyCreate) GetDescriptionOk 

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

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

func (*ObjectTypePropertyCreate) GetDisplayOrder 

func (o *ObjectTypePropertyCreate) GetDisplayOrder() int32

GetDisplayOrder returns the DisplayOrder field value if set, zero value otherwise.

func (*ObjectTypePropertyCreate) GetDisplayOrderOk 

func (o *ObjectTypePropertyCreate) GetDisplayOrderOk() (*int32, bool)

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

func (*ObjectTypePropertyCreate) GetFieldType 

func (o *ObjectTypePropertyCreate) GetFieldType() string

GetFieldType returns the FieldType field value

func (*ObjectTypePropertyCreate) GetFieldTypeOk 

func (o *ObjectTypePropertyCreate) GetFieldTypeOk() (*string, bool)

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

func (*ObjectTypePropertyCreate) GetGroupName 

func (o *ObjectTypePropertyCreate) GetGroupName() string

GetGroupName returns the GroupName field value if set, zero value otherwise.

func (*ObjectTypePropertyCreate) GetGroupNameOk 

func (o *ObjectTypePropertyCreate) GetGroupNameOk() (*string, bool)

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

func (*ObjectTypePropertyCreate) GetHasUniqueValue 

func (o *ObjectTypePropertyCreate) GetHasUniqueValue() bool

GetHasUniqueValue returns the HasUniqueValue field value if set, zero value otherwise.

func (*ObjectTypePropertyCreate) GetHasUniqueValueOk 

func (o *ObjectTypePropertyCreate) GetHasUniqueValueOk() (*bool, bool)

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

func (*ObjectTypePropertyCreate) GetHidden 

func (o *ObjectTypePropertyCreate) GetHidden() bool

GetHidden returns the Hidden field value if set, zero value otherwise.

func (*ObjectTypePropertyCreate) GetHiddenOk 

func (o *ObjectTypePropertyCreate) GetHiddenOk() (*bool, bool)

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

func (*ObjectTypePropertyCreate) GetLabel 

func (o *ObjectTypePropertyCreate) GetLabel() string

GetLabel returns the Label field value

func (*ObjectTypePropertyCreate) GetLabelOk 

func (o *ObjectTypePropertyCreate) GetLabelOk() (*string, bool)

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

func (*ObjectTypePropertyCreate) GetName 

func (o *ObjectTypePropertyCreate) GetName() string

GetName returns the Name field value

func (*ObjectTypePropertyCreate) GetNameOk 

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

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

func (*ObjectTypePropertyCreate) GetOptions 

func (o *ObjectTypePropertyCreate) GetOptions() []OptionInput

GetOptions returns the Options field value if set, zero value otherwise.

func (*ObjectTypePropertyCreate) GetOptionsOk 

func (o *ObjectTypePropertyCreate) GetOptionsOk() ([]OptionInput, bool)

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

func (*ObjectTypePropertyCreate) GetType 

func (o *ObjectTypePropertyCreate) GetType() string

GetType returns the Type field value

func (*ObjectTypePropertyCreate) GetTypeOk 

func (o *ObjectTypePropertyCreate) GetTypeOk() (*string, bool)

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

func (*ObjectTypePropertyCreate) HasDescription 

func (o *ObjectTypePropertyCreate) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*ObjectTypePropertyCreate) HasDisplayOrder 

func (o *ObjectTypePropertyCreate) HasDisplayOrder() bool

HasDisplayOrder returns a boolean if a field has been set.

func (*ObjectTypePropertyCreate) HasGroupName 

func (o *ObjectTypePropertyCreate) HasGroupName() bool

HasGroupName returns a boolean if a field has been set.

func (*ObjectTypePropertyCreate) HasHasUniqueValue 

func (o *ObjectTypePropertyCreate) HasHasUniqueValue() bool

HasHasUniqueValue returns a boolean if a field has been set.

func (*ObjectTypePropertyCreate) HasHidden 

func (o *ObjectTypePropertyCreate) HasHidden() bool

HasHidden returns a boolean if a field has been set.

func (*ObjectTypePropertyCreate) HasOptions 

func (o *ObjectTypePropertyCreate) HasOptions() bool

HasOptions returns a boolean if a field has been set.

func (ObjectTypePropertyCreate) MarshalJSON 

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

func (*ObjectTypePropertyCreate) SetDescription 

func (o *ObjectTypePropertyCreate) SetDescription(v string)

SetDescription gets a reference to the given string and assigns it to the Description field.

func (*ObjectTypePropertyCreate) SetDisplayOrder 

func (o *ObjectTypePropertyCreate) SetDisplayOrder(v int32)

SetDisplayOrder gets a reference to the given int32 and assigns it to the DisplayOrder field.

func (*ObjectTypePropertyCreate) SetFieldType 

func (o *ObjectTypePropertyCreate) SetFieldType(v string)

SetFieldType sets field value

func (*ObjectTypePropertyCreate) SetGroupName 

func (o *ObjectTypePropertyCreate) SetGroupName(v string)

SetGroupName gets a reference to the given string and assigns it to the GroupName field.

func (*ObjectTypePropertyCreate) SetHasUniqueValue 

func (o *ObjectTypePropertyCreate) SetHasUniqueValue(v bool)

SetHasUniqueValue gets a reference to the given bool and assigns it to the HasUniqueValue field.

func (*ObjectTypePropertyCreate) SetHidden 

func (o *ObjectTypePropertyCreate) SetHidden(v bool)

SetHidden gets a reference to the given bool and assigns it to the Hidden field.

func (*ObjectTypePropertyCreate) SetLabel 

func (o *ObjectTypePropertyCreate) SetLabel(v string)

SetLabel sets field value

func (*ObjectTypePropertyCreate) SetName 

func (o *ObjectTypePropertyCreate) SetName(v string)

SetName sets field value

func (*ObjectTypePropertyCreate) SetOptions 

func (o *ObjectTypePropertyCreate) SetOptions(v []OptionInput)

SetOptions gets a reference to the given []OptionInput and assigns it to the Options field.

func (*ObjectTypePropertyCreate) SetType 

func (o *ObjectTypePropertyCreate) SetType(v string)

SetType sets field value

type Option 

type Option struct {
	// A human-readable option label that will be shown in HubSpot.
	Label string `json:"label"`
	// The internal value of the option, which must be used when setting the property value through the API.
	Value string `json:"value"`
	// A description of the option.
	Description *string `json:"description,omitempty"`
	// Options are displayed in order starting with the lowest positive integer value. Values of -1 will cause the option to be displayed after any positive values.
	DisplayOrder *int32 `json:"displayOrder,omitempty"`
	// Hidden options will not be displayed in HubSpot.
	Hidden bool `json:"hidden"`
}

Option The options available when a property is an enumeration

func NewOption 

func NewOption(label string, value string, hidden bool) *Option

NewOption instantiates a new Option 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 NewOptionWithDefaults 

func NewOptionWithDefaults() *Option

NewOptionWithDefaults instantiates a new Option 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 (*Option) GetDescription 

func (o *Option) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise.

func (*Option) GetDescriptionOk 

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

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

func (*Option) GetDisplayOrder 

func (o *Option) GetDisplayOrder() int32

GetDisplayOrder returns the DisplayOrder field value if set, zero value otherwise.

func (*Option) GetDisplayOrderOk 

func (o *Option) GetDisplayOrderOk() (*int32, bool)

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

func (*Option) GetHidden 

func (o *Option) GetHidden() bool

GetHidden returns the Hidden field value

func (*Option) GetHiddenOk 

func (o *Option) GetHiddenOk() (*bool, bool)

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

func (*Option) GetLabel 

func (o *Option) GetLabel() string

GetLabel returns the Label field value

func (*Option) GetLabelOk 

func (o *Option) GetLabelOk() (*string, bool)

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

func (*Option) GetValue 

func (o *Option) GetValue() string

GetValue returns the Value field value

func (*Option) GetValueOk 

func (o *Option) GetValueOk() (*string, bool)

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

func (*Option) HasDescription 

func (o *Option) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*Option) HasDisplayOrder 

func (o *Option) HasDisplayOrder() bool

HasDisplayOrder returns a boolean if a field has been set.

func (Option) MarshalJSON 

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

func (*Option) SetDescription 

func (o *Option) SetDescription(v string)

SetDescription gets a reference to the given string and assigns it to the Description field.

func (*Option) SetDisplayOrder 

func (o *Option) SetDisplayOrder(v int32)

SetDisplayOrder gets a reference to the given int32 and assigns it to the DisplayOrder field.

func (*Option) SetHidden 

func (o *Option) SetHidden(v bool)

SetHidden sets field value

func (*Option) SetLabel 

func (o *Option) SetLabel(v string)

SetLabel sets field value

func (*Option) SetValue 

func (o *Option) SetValue(v string)

SetValue sets field value

type OptionInput 

type OptionInput struct {
	// A human-readable option label that will be shown in HubSpot.
	Label string `json:"label"`
	// The internal value of the option, which must be used when setting the property value through the API.
	Value string `json:"value"`
	// A description of the option.
	Description *string `json:"description,omitempty"`
	// Options are shown in order starting with the lowest positive integer value. Values of -1 will cause the option to be displayed after any positive values.
	DisplayOrder int32 `json:"displayOrder"`
	// Hidden options won't be shown in HubSpot.
	Hidden bool `json:"hidden"`
}

OptionInput Defines a enumeration property option

func NewOptionInput 

func NewOptionInput(label string, value string, displayOrder int32, hidden bool) *OptionInput

NewOptionInput instantiates a new OptionInput 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 NewOptionInputWithDefaults 

func NewOptionInputWithDefaults() *OptionInput

NewOptionInputWithDefaults instantiates a new OptionInput 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 (*OptionInput) GetDescription 

func (o *OptionInput) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise.

func (*OptionInput) GetDescriptionOk 

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

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

func (*OptionInput) GetDisplayOrder 

func (o *OptionInput) GetDisplayOrder() int32

GetDisplayOrder returns the DisplayOrder field value

func (*OptionInput) GetDisplayOrderOk 

func (o *OptionInput) GetDisplayOrderOk() (*int32, bool)

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

func (*OptionInput) GetHidden 

func (o *OptionInput) GetHidden() bool

GetHidden returns the Hidden field value

func (*OptionInput) GetHiddenOk 

func (o *OptionInput) GetHiddenOk() (*bool, bool)

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

func (*OptionInput) GetLabel 

func (o *OptionInput) GetLabel() string

GetLabel returns the Label field value

func (*OptionInput) GetLabelOk 

func (o *OptionInput) GetLabelOk() (*string, bool)

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

func (*OptionInput) GetValue 

func (o *OptionInput) GetValue() string

GetValue returns the Value field value

func (*OptionInput) GetValueOk 

func (o *OptionInput) GetValueOk() (*string, bool)

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

func (*OptionInput) HasDescription 

func (o *OptionInput) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (OptionInput) MarshalJSON 

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

func (*OptionInput) SetDescription 

func (o *OptionInput) SetDescription(v string)

SetDescription gets a reference to the given string and assigns it to the Description field.

func (*OptionInput) SetDisplayOrder 

func (o *OptionInput) SetDisplayOrder(v int32)

SetDisplayOrder sets field value

func (*OptionInput) SetHidden 

func (o *OptionInput) SetHidden(v bool)

SetHidden sets field value

func (*OptionInput) SetLabel 

func (o *OptionInput) SetLabel(v string)

SetLabel sets field value

func (*OptionInput) SetValue 

func (o *OptionInput) SetValue(v string)

SetValue sets field value

type Property 

type Property struct {
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
	// When the property was created
	CreatedAt *time.Time `json:"createdAt,omitempty"`
	// When the property was archived.
	ArchivedAt *time.Time `json:"archivedAt,omitempty"`
	// The internal property name, which must be used when referencing the property via the API.
	Name string `json:"name"`
	// A human-readable property label that will be shown in HubSpot.
	Label string `json:"label"`
	// The property data type.
	Type string `json:"type"`
	// Controls how the property appears in HubSpot.
	FieldType string `json:"fieldType"`
	// A description of the property that will be shown as help text in HubSpot.
	Description string `json:"description"`
	// The name of the property group the property belongs to.
	GroupName string `json:"groupName"`
	// A list of valid options for the property. This field is required for enumerated properties, but will be empty for other property types.
	Options []Option `json:"options"`
	// The internal ID of the user who created the property in HubSpot. This field may not exist if the property was created outside of HubSpot.
	CreatedUserId *string `json:"createdUserId,omitempty"`
	// The internal user ID of the user who updated the property in HubSpot. This field may not exist if the property was updated outside of HubSpot.
	UpdatedUserId *string `json:"updatedUserId,omitempty"`
	// If this property is related to other object(s), they'll be listed here.
	ReferencedObjectType *string `json:"referencedObjectType,omitempty"`
	// The order that this property should be displayed in the HubSpot UI relative to other properties for this object type. Properties are displayed in order starting with the lowest positive integer value. A value of -1 will cause the property to be displayed **after** any positive values.
	DisplayOrder *int32 `json:"displayOrder,omitempty"`
	// For default properties, true indicates that the property is calculated by a HubSpot process. It has no effect for custom properties.
	Calculated *bool `json:"calculated,omitempty"`
	// For default properties, true indicates that the options are stored externally to the property settings.
	ExternalOptions *bool `json:"externalOptions,omitempty"`
	// Whether or not the property is archived.
	Archived *bool `json:"archived,omitempty"`
	// Whether or not the property's value must be unique. Once set, this can't be changed.
	HasUniqueValue *bool `json:"hasUniqueValue,omitempty"`
	Hidden         *bool `json:"hidden,omitempty"`
	// This will be true for default object properties built into HubSpot.
	HubspotDefined *bool `json:"hubspotDefined,omitempty"`
	// Whether the property will display the currency symbol set in the account settings.
	ShowCurrencySymbol   *bool                         `json:"showCurrencySymbol,omitempty"`
	ModificationMetadata *PropertyModificationMetadata `json:"modificationMetadata,omitempty"`
	// Whether or not the property can be used in a HubSpot form.
	FormField *bool `json:"formField,omitempty"`
}

Property Defines a property

func NewProperty 

func NewProperty(name string, label string, type_ string, fieldType string, description string, groupName string, options []Option) *Property

NewProperty instantiates a new Property 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 NewPropertyWithDefaults 

func NewPropertyWithDefaults() *Property

NewPropertyWithDefaults instantiates a new Property 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 (*Property) GetArchived 

func (o *Property) GetArchived() bool

GetArchived returns the Archived field value if set, zero value otherwise.

func (*Property) GetArchivedAt 

func (o *Property) GetArchivedAt() time.Time

GetArchivedAt returns the ArchivedAt field value if set, zero value otherwise.

func (*Property) GetArchivedAtOk 

func (o *Property) GetArchivedAtOk() (*time.Time, bool)

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

func (*Property) GetArchivedOk 

func (o *Property) GetArchivedOk() (*bool, bool)

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

func (*Property) GetCalculated 

func (o *Property) GetCalculated() bool

GetCalculated returns the Calculated field value if set, zero value otherwise.

func (*Property) GetCalculatedOk 

func (o *Property) GetCalculatedOk() (*bool, bool)

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

func (*Property) GetCreatedAt 

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

GetCreatedAt returns the CreatedAt field value if set, zero value otherwise.

func (*Property) GetCreatedAtOk 

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

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

func (*Property) GetCreatedUserId 

func (o *Property) GetCreatedUserId() string

GetCreatedUserId returns the CreatedUserId field value if set, zero value otherwise.

func (*Property) GetCreatedUserIdOk 

func (o *Property) GetCreatedUserIdOk() (*string, bool)

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

func (*Property) GetDescription 

func (o *Property) GetDescription() string

GetDescription returns the Description field value

func (*Property) GetDescriptionOk 

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

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

func (*Property) GetDisplayOrder 

func (o *Property) GetDisplayOrder() int32

GetDisplayOrder returns the DisplayOrder field value if set, zero value otherwise.

func (*Property) GetDisplayOrderOk 

func (o *Property) GetDisplayOrderOk() (*int32, bool)

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

func (*Property) GetExternalOptions 

func (o *Property) GetExternalOptions() bool

GetExternalOptions returns the ExternalOptions field value if set, zero value otherwise.

func (*Property) GetExternalOptionsOk 

func (o *Property) GetExternalOptionsOk() (*bool, bool)

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

func (*Property) GetFieldType 

func (o *Property) GetFieldType() string

GetFieldType returns the FieldType field value

func (*Property) GetFieldTypeOk 

func (o *Property) GetFieldTypeOk() (*string, bool)

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

func (*Property) GetFormField 

func (o *Property) GetFormField() bool

GetFormField returns the FormField field value if set, zero value otherwise.

func (*Property) GetFormFieldOk 

func (o *Property) GetFormFieldOk() (*bool, bool)

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

func (*Property) GetGroupName 

func (o *Property) GetGroupName() string

GetGroupName returns the GroupName field value

func (*Property) GetGroupNameOk 

func (o *Property) GetGroupNameOk() (*string, bool)

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

func (*Property) GetHasUniqueValue 

func (o *Property) GetHasUniqueValue() bool

GetHasUniqueValue returns the HasUniqueValue field value if set, zero value otherwise.

func (*Property) GetHasUniqueValueOk 

func (o *Property) GetHasUniqueValueOk() (*bool, bool)

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

func (*Property) GetHidden 

func (o *Property) GetHidden() bool

GetHidden returns the Hidden field value if set, zero value otherwise.

func (*Property) GetHiddenOk 

func (o *Property) GetHiddenOk() (*bool, bool)

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

func (*Property) GetHubspotDefined 

func (o *Property) GetHubspotDefined() bool

GetHubspotDefined returns the HubspotDefined field value if set, zero value otherwise.

func (*Property) GetHubspotDefinedOk 

func (o *Property) GetHubspotDefinedOk() (*bool, bool)

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

func (*Property) GetLabel 

func (o *Property) GetLabel() string

GetLabel returns the Label field value

func (*Property) GetLabelOk 

func (o *Property) GetLabelOk() (*string, bool)

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

func (*Property) GetModificationMetadata 

func (o *Property) GetModificationMetadata() PropertyModificationMetadata

GetModificationMetadata returns the ModificationMetadata field value if set, zero value otherwise.

func (*Property) GetModificationMetadataOk 

func (o *Property) GetModificationMetadataOk() (*PropertyModificationMetadata, bool)

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

func (*Property) GetName 

func (o *Property) GetName() string

GetName returns the Name field value

func (*Property) GetNameOk 

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

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

func (*Property) GetOptions 

func (o *Property) GetOptions() []Option

GetOptions returns the Options field value

func (*Property) GetOptionsOk 

func (o *Property) GetOptionsOk() ([]Option, bool)

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

func (*Property) GetReferencedObjectType 

func (o *Property) GetReferencedObjectType() string

GetReferencedObjectType returns the ReferencedObjectType field value if set, zero value otherwise.

func (*Property) GetReferencedObjectTypeOk 

func (o *Property) GetReferencedObjectTypeOk() (*string, bool)

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

func (*Property) GetShowCurrencySymbol 

func (o *Property) GetShowCurrencySymbol() bool

GetShowCurrencySymbol returns the ShowCurrencySymbol field value if set, zero value otherwise.

func (*Property) GetShowCurrencySymbolOk 

func (o *Property) GetShowCurrencySymbolOk() (*bool, bool)

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

func (*Property) GetType 

func (o *Property) GetType() string

GetType returns the Type field value

func (*Property) GetTypeOk 

func (o *Property) GetTypeOk() (*string, bool)

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

func (*Property) GetUpdatedAt 

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

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

func (*Property) GetUpdatedAtOk 

func (o *Property) 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 (*Property) GetUpdatedUserId 

func (o *Property) GetUpdatedUserId() string

GetUpdatedUserId returns the UpdatedUserId field value if set, zero value otherwise.

func (*Property) GetUpdatedUserIdOk 

func (o *Property) GetUpdatedUserIdOk() (*string, bool)

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

func (*Property) HasArchived 

func (o *Property) HasArchived() bool

HasArchived returns a boolean if a field has been set.

func (*Property) HasArchivedAt 

func (o *Property) HasArchivedAt() bool

HasArchivedAt returns a boolean if a field has been set.

func (*Property) HasCalculated 

func (o *Property) HasCalculated() bool

HasCalculated returns a boolean if a field has been set.

func (*Property) HasCreatedAt 

func (o *Property) HasCreatedAt() bool

HasCreatedAt returns a boolean if a field has been set.

func (*Property) HasCreatedUserId 

func (o *Property) HasCreatedUserId() bool

HasCreatedUserId returns a boolean if a field has been set.

func (*Property) HasDisplayOrder 

func (o *Property) HasDisplayOrder() bool

HasDisplayOrder returns a boolean if a field has been set.

func (*Property) HasExternalOptions 

func (o *Property) HasExternalOptions() bool

HasExternalOptions returns a boolean if a field has been set.

func (*Property) HasFormField 

func (o *Property) HasFormField() bool

HasFormField returns a boolean if a field has been set.

func (*Property) HasHasUniqueValue 

func (o *Property) HasHasUniqueValue() bool

HasHasUniqueValue returns a boolean if a field has been set.

func (*Property) HasHidden 

func (o *Property) HasHidden() bool

HasHidden returns a boolean if a field has been set.

func (*Property) HasHubspotDefined 

func (o *Property) HasHubspotDefined() bool

HasHubspotDefined returns a boolean if a field has been set.

func (*Property) HasModificationMetadata 

func (o *Property) HasModificationMetadata() bool

HasModificationMetadata returns a boolean if a field has been set.

func (*Property) HasReferencedObjectType 

func (o *Property) HasReferencedObjectType() bool

HasReferencedObjectType returns a boolean if a field has been set.

func (*Property) HasShowCurrencySymbol 

func (o *Property) HasShowCurrencySymbol() bool

HasShowCurrencySymbol returns a boolean if a field has been set.

func (*Property) HasUpdatedAt 

func (o *Property) HasUpdatedAt() bool

HasUpdatedAt returns a boolean if a field has been set.

func (*Property) HasUpdatedUserId 

func (o *Property) HasUpdatedUserId() bool

HasUpdatedUserId returns a boolean if a field has been set.

func (Property) MarshalJSON 

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

func (*Property) SetArchived 

func (o *Property) SetArchived(v bool)

SetArchived gets a reference to the given bool and assigns it to the Archived field.

func (*Property) SetArchivedAt 

func (o *Property) SetArchivedAt(v time.Time)

SetArchivedAt gets a reference to the given time.Time and assigns it to the ArchivedAt field.

func (*Property) SetCalculated 

func (o *Property) SetCalculated(v bool)

SetCalculated gets a reference to the given bool and assigns it to the Calculated field.

func (*Property) SetCreatedAt 

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

SetCreatedAt gets a reference to the given time.Time and assigns it to the CreatedAt field.

func (*Property) SetCreatedUserId 

func (o *Property) SetCreatedUserId(v string)

SetCreatedUserId gets a reference to the given string and assigns it to the CreatedUserId field.

func (*Property) SetDescription 

func (o *Property) SetDescription(v string)

SetDescription sets field value

func (*Property) SetDisplayOrder 

func (o *Property) SetDisplayOrder(v int32)

SetDisplayOrder gets a reference to the given int32 and assigns it to the DisplayOrder field.

func (*Property) SetExternalOptions 

func (o *Property) SetExternalOptions(v bool)

SetExternalOptions gets a reference to the given bool and assigns it to the ExternalOptions field.

func (*Property) SetFieldType 

func (o *Property) SetFieldType(v string)

SetFieldType sets field value

func (*Property) SetFormField 

func (o *Property) SetFormField(v bool)

SetFormField gets a reference to the given bool and assigns it to the FormField field.

func (*Property) SetGroupName 

func (o *Property) SetGroupName(v string)

SetGroupName sets field value

func (*Property) SetHasUniqueValue 

func (o *Property) SetHasUniqueValue(v bool)

SetHasUniqueValue gets a reference to the given bool and assigns it to the HasUniqueValue field.

func (*Property) SetHidden 

func (o *Property) SetHidden(v bool)

SetHidden gets a reference to the given bool and assigns it to the Hidden field.

func (*Property) SetHubspotDefined 

func (o *Property) SetHubspotDefined(v bool)

SetHubspotDefined gets a reference to the given bool and assigns it to the HubspotDefined field.

func (*Property) SetLabel 

func (o *Property) SetLabel(v string)

SetLabel sets field value

func (*Property) SetModificationMetadata 

func (o *Property) SetModificationMetadata(v PropertyModificationMetadata)

SetModificationMetadata gets a reference to the given PropertyModificationMetadata and assigns it to the ModificationMetadata field.

func (*Property) SetName 

func (o *Property) SetName(v string)

SetName sets field value

func (*Property) SetOptions 

func (o *Property) SetOptions(v []Option)

SetOptions sets field value

func (*Property) SetReferencedObjectType 

func (o *Property) SetReferencedObjectType(v string)

SetReferencedObjectType gets a reference to the given string and assigns it to the ReferencedObjectType field.

func (*Property) SetShowCurrencySymbol 

func (o *Property) SetShowCurrencySymbol(v bool)

SetShowCurrencySymbol gets a reference to the given bool and assigns it to the ShowCurrencySymbol field.

func (*Property) SetType 

func (o *Property) SetType(v string)

SetType sets field value

func (*Property) SetUpdatedAt 

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

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

func (*Property) SetUpdatedUserId 

func (o *Property) SetUpdatedUserId(v string)

SetUpdatedUserId gets a reference to the given string and assigns it to the UpdatedUserId field.

type PropertyModificationMetadata 

type PropertyModificationMetadata struct {
	Archivable         bool  `json:"archivable"`
	ReadOnlyDefinition bool  `json:"readOnlyDefinition"`
	ReadOnlyOptions    *bool `json:"readOnlyOptions,omitempty"`
	ReadOnlyValue      bool  `json:"readOnlyValue"`
}

PropertyModificationMetadata struct for PropertyModificationMetadata

func NewPropertyModificationMetadata 

func NewPropertyModificationMetadata(archivable bool, readOnlyDefinition bool, readOnlyValue bool) *PropertyModificationMetadata

NewPropertyModificationMetadata instantiates a new PropertyModificationMetadata 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 NewPropertyModificationMetadataWithDefaults 

func NewPropertyModificationMetadataWithDefaults() *PropertyModificationMetadata

NewPropertyModificationMetadataWithDefaults instantiates a new PropertyModificationMetadata 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 (*PropertyModificationMetadata) GetArchivable 

func (o *PropertyModificationMetadata) GetArchivable() bool

GetArchivable returns the Archivable field value

func (*PropertyModificationMetadata) GetArchivableOk 

func (o *PropertyModificationMetadata) GetArchivableOk() (*bool, bool)

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

func (*PropertyModificationMetadata) GetReadOnlyDefinition 

func (o *PropertyModificationMetadata) GetReadOnlyDefinition() bool

GetReadOnlyDefinition returns the ReadOnlyDefinition field value

func (*PropertyModificationMetadata) GetReadOnlyDefinitionOk 

func (o *PropertyModificationMetadata) GetReadOnlyDefinitionOk() (*bool, bool)

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

func (*PropertyModificationMetadata) GetReadOnlyOptions 

func (o *PropertyModificationMetadata) GetReadOnlyOptions() bool

GetReadOnlyOptions returns the ReadOnlyOptions field value if set, zero value otherwise.

func (*PropertyModificationMetadata) GetReadOnlyOptionsOk 

func (o *PropertyModificationMetadata) GetReadOnlyOptionsOk() (*bool, bool)

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

func (*PropertyModificationMetadata) GetReadOnlyValue 

func (o *PropertyModificationMetadata) GetReadOnlyValue() bool

GetReadOnlyValue returns the ReadOnlyValue field value

func (*PropertyModificationMetadata) GetReadOnlyValueOk 

func (o *PropertyModificationMetadata) GetReadOnlyValueOk() (*bool, bool)

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

func (*PropertyModificationMetadata) HasReadOnlyOptions 

func (o *PropertyModificationMetadata) HasReadOnlyOptions() bool

HasReadOnlyOptions returns a boolean if a field has been set.

func (PropertyModificationMetadata) MarshalJSON 

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

func (*PropertyModificationMetadata) SetArchivable 

func (o *PropertyModificationMetadata) SetArchivable(v bool)

SetArchivable sets field value

func (*PropertyModificationMetadata) SetReadOnlyDefinition 

func (o *PropertyModificationMetadata) SetReadOnlyDefinition(v bool)

SetReadOnlyDefinition sets field value

func (*PropertyModificationMetadata) SetReadOnlyOptions 

func (o *PropertyModificationMetadata) SetReadOnlyOptions(v bool)

SetReadOnlyOptions gets a reference to the given bool and assigns it to the ReadOnlyOptions field.

func (*PropertyModificationMetadata) SetReadOnlyValue 

func (o *PropertyModificationMetadata) SetReadOnlyValue(v bool)

SetReadOnlyValue sets field value

type PublicObjectSchemasApiService 

type PublicObjectSchemasApiService service

PublicObjectSchemasApiService PublicObjectSchemasApi service

func (*PublicObjectSchemasApiService) Purge 

func (a *PublicObjectSchemasApiService) Purge(ctx context.Context, objectType string) ApiPurgeRequest

Purge Method for Purge 

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

Deprecated

func (*PublicObjectSchemasApiService) PurgeExecute 

func (a *PublicObjectSchemasApiService) PurgeExecute(r ApiPurgeRequest) (*http.Response, error)

Execute executes the request Deprecated

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.