Class GroupsApi

Index

Constructors

Methods

archive archiveWithHttpInfo create createWithHttpInfo getAll getAllWithHttpInfo getByName getByNameWithHttpInfo update updateWithHttpInfo

Constructors

constructor

new GroupsApi(configuration, requestFactory?, responseProcessor?): GroupsApi
Parameters
- configuration: Configuration<ObservableMiddleware>
- OptionalrequestFactory: GroupsApiRequestFactory
- OptionalresponseProcessor: GroupsApiResponseProcessor
Returns GroupsApi
- Defined in codegen/crm/properties/types/PromiseAPI.ts:438

Methods

archiveWithHttpInfo

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

create

create(objectType, propertyGroupCreate, _options?): Promise<PropertyGroup>
Create and return a copy of a new property group. Create a property group
Parameters
- objectType: string
- propertyGroupCreate: PropertyGroupCreate
- Optional_options: PromiseConfigurationOptions
Returns Promise<PropertyGroup>
- Defined in codegen/crm/properties/types/PromiseAPI.ts:521

createWithHttpInfo

createWithHttpInfo(objectType, propertyGroupCreate, _options?): Promise<HttpInfo<PropertyGroup>>
Create and return a copy of a new property group. Create a property group
Parameters
- objectType: string
- propertyGroupCreate: PropertyGroupCreate
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<PropertyGroup>>
- Defined in codegen/crm/properties/types/PromiseAPI.ts:498

getAll

getAll(objectType, _options?): Promise<CollectionResponsePropertyGroupNoPaging>
Read all existing property groups for the specified object type and HubSpot account. Read all property groups
Parameters
- objectType: string
- Optional_options: PromiseConfigurationOptions
Returns Promise<CollectionResponsePropertyGroupNoPaging>
- Defined in codegen/crm/properties/types/PromiseAPI.ts:565

getAllWithHttpInfo

getAllWithHttpInfo(objectType, _options?): Promise<HttpInfo<CollectionResponsePropertyGroupNoPaging>>
Read all existing property groups for the specified object type and HubSpot account. Read all property groups
Parameters
- objectType: string
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<CollectionResponsePropertyGroupNoPaging>>
- Defined in codegen/crm/properties/types/PromiseAPI.ts:543

getByName

getByName(objectType, groupName, _options?): Promise<PropertyGroup>
Read a property group identified by {groupName}. Read a property group
Parameters
- objectType: string
- groupName: string
- Optional_options: PromiseConfigurationOptions
Returns Promise<PropertyGroup>
- Defined in codegen/crm/properties/types/PromiseAPI.ts:611

getByNameWithHttpInfo

getByNameWithHttpInfo(objectType, groupName, _options?): Promise<HttpInfo<PropertyGroup>>
Read a property group identified by {groupName}. Read a property group
Parameters
- objectType: string
- groupName: string
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<PropertyGroup>>
- Defined in codegen/crm/properties/types/PromiseAPI.ts:588

update

update(objectType, groupName, propertyGroupUpdate, _options?): Promise<PropertyGroup>
Perform a partial update of a property group identified by {groupName}. Provided fields will be overwritten. Update a property group
Parameters
- objectType: string
- groupName: string
- propertyGroupUpdate: PropertyGroupUpdate
- Optional_options: PromiseConfigurationOptions
Returns Promise<PropertyGroup>
- Defined in codegen/crm/properties/types/PromiseAPI.ts:659

updateWithHttpInfo

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

Class GroupsApi

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns GroupsApi

Methods

archive

Parameters

Returns Promise<void>

archiveWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

create

Parameters

Returns Promise<PropertyGroup>

createWithHttpInfo

Parameters

Returns Promise<HttpInfo<PropertyGroup>>

getAll

Parameters

Returns Promise<CollectionResponsePropertyGroupNoPaging>

getAllWithHttpInfo

Parameters

Returns Promise<HttpInfo<CollectionResponsePropertyGroupNoPaging>>

getByName

Parameters

Returns Promise<PropertyGroup>

getByNameWithHttpInfo

Parameters

Returns Promise<HttpInfo<PropertyGroup>>

update

Parameters

Returns Promise<PropertyGroup>

updateWithHttpInfo

Parameters

Returns Promise<HttpInfo<PropertyGroup>>

Settings

On This Page