Class CoreApi

Index

Constructors

Methods

archive archiveWithHttpInfo create createWithHttpInfo getAll getAllWithHttpInfo getByName getByNameWithHttpInfo update updateWithHttpInfo

Constructors

constructor

new CoreApi(configuration, requestFactory?, responseProcessor?): CoreApi
Parameters
- configuration: Configuration<ObservableMiddleware>
- OptionalrequestFactory: CoreApiRequestFactory
- OptionalresponseProcessor: CoreApiResponseProcessor
Returns CoreApi
- Defined in codegen/crm/properties/types/PromiseAPI.ts:181

Methods

archiveWithHttpInfo

archiveWithHttpInfo(objectType, propertyName, _options?): Promise<HttpInfo<void>>
Move a property identified by {propertyName} to the recycling bin. Archive a property
Parameters
- objectType: string
- propertyName: string
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/crm/properties/types/PromiseAPI.ts:195

create

create(objectType, propertyCreate, _options?): Promise<Property>
Create and return a copy of a new property for the specified object type. Create a property
Parameters
- objectType: string
- propertyCreate: PropertyCreate
- Optional_options: PromiseConfigurationOptions
Returns Promise<Property>
- Defined in codegen/crm/properties/types/PromiseAPI.ts:264

createWithHttpInfo

createWithHttpInfo(objectType, propertyCreate, _options?): Promise<HttpInfo<Property>>
Create and return a copy of a new property for the specified object type. Create a property
Parameters
- objectType: string
- propertyCreate: PropertyCreate
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<Property>>
- Defined in codegen/crm/properties/types/PromiseAPI.ts:241

getAll

getAll(objectType, archived?, properties?, _options?): Promise<CollectionResponsePropertyNoPaging>
Read all existing properties for the specified object type and HubSpot account. Read all properties
Parameters
- objectType: string
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- Optionalproperties: string
- Optional_options: PromiseConfigurationOptions
Returns Promise<CollectionResponsePropertyNoPaging>
- Defined in codegen/crm/properties/types/PromiseAPI.ts:312

getAllWithHttpInfo

getAllWithHttpInfo(objectType, archived?, properties?, _options?): Promise<HttpInfo<CollectionResponsePropertyNoPaging>>
Read all existing properties for the specified object type and HubSpot account. Read all properties
Parameters
- objectType: string
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- Optionalproperties: string
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<CollectionResponsePropertyNoPaging>>
- Defined in codegen/crm/properties/types/PromiseAPI.ts:288

getByName

getByName(objectType, propertyName, archived?, properties?, _options?): Promise<Property>
Read a property identified by {propertyName}. Read a property
Parameters
- objectType: string
- propertyName: string
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- Optionalproperties: string
- Optional_options: PromiseConfigurationOptions
Returns Promise<Property>
- Defined in codegen/crm/properties/types/PromiseAPI.ts:362

getByNameWithHttpInfo

getByNameWithHttpInfo(objectType, propertyName, archived?, properties?, _options?): Promise<HttpInfo<Property>>
Read a property identified by {propertyName}. Read a property
Parameters
- objectType: string
- propertyName: string
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- Optionalproperties: string
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<Property>>
- Defined in codegen/crm/properties/types/PromiseAPI.ts:337

update

update(objectType, propertyName, propertyUpdate, _options?): Promise<Property>
Perform a partial update of a property identified by {propertyName}. Provided fields will be overwritten. Update a property
Parameters
- objectType: string
- propertyName: string
- propertyUpdate: PropertyUpdate
- Optional_options: PromiseConfigurationOptions
Returns Promise<Property>
- Defined in codegen/crm/properties/types/PromiseAPI.ts:410

updateWithHttpInfo

updateWithHttpInfo(objectType, propertyName, propertyUpdate, _options?): Promise<HttpInfo<Property>>
Perform a partial update of a property identified by {propertyName}. Provided fields will be overwritten. Update a property
Parameters
- objectType: string
- propertyName: string
- propertyUpdate: PropertyUpdate
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<Property>>
- Defined in codegen/crm/properties/types/PromiseAPI.ts:386

Class CoreApi

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CoreApi

Methods

archive

Parameters

Returns Promise<void>

archiveWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

create

Parameters

Returns Promise<Property>

createWithHttpInfo

Parameters

Returns Promise<HttpInfo<Property>>

getAll

Parameters

Returns Promise<CollectionResponsePropertyNoPaging>

getAllWithHttpInfo

Parameters

Returns Promise<HttpInfo<CollectionResponsePropertyNoPaging>>

getByName

Parameters

Returns Promise<Property>

getByNameWithHttpInfo

Parameters

Returns Promise<HttpInfo<Property>>

update

Parameters

Returns Promise<Property>

updateWithHttpInfo

Parameters

Returns Promise<HttpInfo<Property>>

Settings

On This Page