Releases: HubSpot/hubspot-api-nodejs
Releases · HubSpot/hubspot-api-nodejs
11.0.0-beta.0
Non-breaking changes
crm.companies.gdprApi
API client.crm.deals.gdprApi
API client.crm.extensions.calling.recordingSettingsApi
API client.crm.line_items.gdprApi
API client.crm.objects.calls.gdprApi
API client.crm.objects.communications.gdprApi
API client.crm.objects.emails.gdprApi
API client.crm.objects.feedbackSubmissions.gdprApi
API client.crm.objects.meetings.gdprApi
API client.crm.objects.notes.gdprApi
API client.crm.objects.postalMail.gdprApi
API client.crm.objects.tasks.gdprApi
API client.crm.products.gdprApi
API client.crm.quotes.gdprApi
API client.crm.tickets.gdprApi
API client.- Added new function type
POST_ACTION_EXECUTION
to all methods ofautomation.actions.functionsApi
.
Breaking changes
automation.actions.definitionsAPI.create(appId: number, extensionActionDefinitionInput: ExtensionActionDefinitionInput):Promise<ExtensionActionDefinition>
=>automation.actions.definitionsAPI.create(appId: number, publicActionDefinitionEgg: PublicActionDefinitionEgg):Promise<PublicActionDefinition>
.automation.actions.definitionsAPI.getById():Promise<ExtensionActionDefinition>
=>automation.actions.definitionsAPI.getById():Promise<PublicActionDefinition>
.automation.actions.definitionsAPI.update(definitionId: string, appId: number, extensionActionDefinitionPatch: ExtensionActionDefinitionPatch):Promise<ExtensionActionDefinition>
=>automation.actions.definitionsAPI.update(definitionId: string, appId: number, publicActionDefinitionPatch: PublicActionDefinitionPatch):Promise<PublicActionDefinition>
.automation.actions.definitionsAPI.getPage():Promise<CollectionResponseExtensionActionDefinitionForwardPaging>
=>automation.actions.definitionsAPI.getPage():Promise<CollectionResponsePublicActionDefinitionForwardPaging>
.automation.actions.functionsApi.createOrReplace():Promise<ActionFunctionIdentifier>
=>automation.actions.functionsApi.createOrReplace():Promise<PublicActionFunctionIdentifier >
.automation.actions.functionsApi.createOrReplaceByFunctionType():Promise<ActionFunctionIdentifier>
=>automation.actions.functionsApi.createOrReplaceByFunctionType():Promise<PublicActionFunctionIdentifier >
.automation.actions.functionsApi.getByFunctionType():Promise<ActionFunction>
=>automation.actions.functionsApi.getByFunctionType():Promise<PublicActionFunction>
.automation.actions.functionsApi.getById():Promise<ActionFunction>
=>automation.actions.functionsApi.getById():Promise<PublicActionFunction>
.automation.actions.functionsApi.getPage():Promise<CollectionResponseActionFunctionIdentifierNoPaging>
=>automation.actions.functionsApi.getPage():Promise<CollectionResponsePublicActionFunctionIdentifierNoPaging>
.automation.actions.revisionsApi.getById():Promise<ActionRevision>
=>automation.actions.revisionsApi.getById():Promise<PublicActionRevision>
.automation.actions.revisionsApi.getPage():Promise<CollectionResponseActionRevisionForwardPaging>
=>automation.actions.revisionsApi.getPage():Promise<CollectionResponsePublicActionRevisionForwardPaging>
.- Added param
property
tocms.blogs.authors.blogAuthorsApi.getById()
. - Added param
property
tocms.blogs.authors.blogAuthorsApi.getPage()
. - Changed type from laguages enum to
string
incms/blogs/authors/models/AttachToLangPrimaryRequestVNext::language
andcms/blogs/authors/models/AttachToLangPrimaryRequestVNext::primaryLanguage
. - Added param
property
tocms.blogs.blogPosts.blogPostsApi.getById()
. - Added param
property
tocms.blogs.blogPosts.blogPostsApi.getPage()
. - Changed type from laguages enum to
string
incms/blogs/blog_posts/models/AttachToLangPrimaryRequestVNext::language
andcms/blogs/blog_posts/models/AttachToLangPrimaryRequestVNext::primaryLanguage
. - Cnange type from
SideOrCornerVerticalSideEnum
tostring
incms/blogs/blog_posts/models/SideOrCorner::verticalSide
. - Cnange type from
SideOrCornerHorizontalSideEnum
tostring
incms/blogs/blog_posts/models/SideOrCorner::horizontalSide
. - Cnange type from
StylesVerticalAlignmentEnum
tostring
incms/blogs/blog_posts/models/Styles::verticalAlignment
. - Cnange type from
StylesFlexboxPositioningEnum
tostring
incms/blogs/blog_posts/models/Styles::flexboxPositioning
. - Added param
property
tocms.blogs.tags.blogTagsApi.getById()
. - Added param
property
tocms.blogs.tags.blogTagsApi.getPage()
. - Changed type from laguages enum to
string
incms/blogs/tags/models/AttachToLangPrimaryRequestVNext::language
andcms/blogs/tags/models/AttachToLangPrimaryRequestVNext::primaryLanguage
. - Cnange type from
ErrorCategory
tostring
incrm/associations/models/StandardError::category
. crm.associations.v4.basicApi.create(): Promise<LabelsBetweenObjectPair>
=>crm.associations.v4.basicApi.create(): Promise<LabelsBetweenObjectPair1>
- Cnange type from
ErrorCategory
tostring
incrm/associations/v4/models/StandardError::category
. - Rename
crm.associations.v4.schema.definitionsApi._delete()
=>crm.associations.v4.schema.definitionsApi.archive()
. - Removed
crm.objects.associationsApi
. - Cnange type from
number
tostring
inPublicObjectSearchRequest::after
in all CRM clients. crm.objects.postalMail.basicApi.archive(postalMail: string, _options?: Configuration)
=>crm.objects.postalMail.basicApi.archive(postalMailId: string, _options?: Configuration)
.crm.objects.postalMail.basicApi.getById(postalMail: string, properties?: Array<string>, propertiesWithHistory?: Array<string>, associations?: Array<string>, archived?: boolean, idProperty?: string, _options?: Configuration)
=>crm.objects.postalMail.basicApi.getById(postalMailId: string, properties?: Array<string>, propertiesWithHistory?: Array<string>, associations?: Array<string>, archived?: boolean, idProperty?: string, _options?: Configuration)
.crm.objects.postalMail.basicApi.update(postalMail: string, simplePublicObjectInput: SimplePublicObjectInput, idProperty?: string, _options?: Configuration)
=>crm.objects.postalMail.basicApi.update(postalMailId: string, simplePublicObjectInput: SimplePublicObjectInput, idProperty?: string, _options?: Configuration)
.- Added param
validateDealStageUsagesBeforeDelete
tocms.pipelines.pipelinesApi.archive()
,cms.pipelines.pipelinesApi.replace()
andcms.pipelines.pipelinesApi.update()
. events.eventsApi.getPage(occurredAfter?: Date, occurredBefore?: Date, objectType?: string, objectId?: number, eventType?: string, after?: string, before?: string, limit?: number, sort?: Array<string>, _options?: Configuration)
=>events.eventsApi.getPage(objectType?: string, eventType?: string, occurredAfter?: Date, occurredBefore?: Date, objectId?: number, indexTableName?: string, indexSpecificMetadata?: string, after?: string, before?: string, limit?: number, sort?: Array<string>, objectPropertyPropname?: any, propertyPropname?: any, id?: Array<string>, _options?: Configuration)
- Rewrite all enums from type to enum.
export type Enum = "OPTION1" | "OPTION2";
// =>
export enum Enum {
Option1 = 'OPTION1',
Option2 = 'OPTION2'
}
10.2.0
Added:
cms.pages
Api client.crm.lists
Api client.crm.objects.goals
Api client.crm.objects.taxes
Api client.events.send
Api client.settings.businessUnits
Api client.
10.1.0
Added marketing.forms
Api client.
10.0.0
Updated
cms.auditLogs.auditLogsApi.getPage(objectId?: Array<string>, userId?: Array<string>, after?: string, before?: string, sort?: Array<string>, eventType?: Array<string>, limit?: number, objectType?: Array<string>, _options?: Configuration)
=>cms.auditLogs.auditLogsApi.getPage(userId?: Array<string>, eventType?: Array<string>, objectType?: Array<string>, objectId?: Array<string>, after?: string, before?: string, limit?: number, sort?: Array<string>, _options?: Configuration)
- Cnange type from
number
tostring
incms/hubdb/models/HubDbTableRowV3BatchUpdateRequest.id
. - Nullable
startDatetime
,endDatetime
andtotalRequestTime
incms/performance/models/PerformanceView
. - Rename
cms.sourceCode.contentApi.get()
=>cms.sourceCode.contentApi.download()
- Rename
cms.sourceCode.contentApi.replace()
=>cms.sourceCode.contentApi.createOrUpdate()
crm.timeline.eventsApi.createBatch() BatchResponseTimelineEventResponse | BatchResponseTimelineEventResponseWithErrors
=>crm.timeline.eventsApi.createBatch() BatchResponseTimelineEventResponse | void | BatchResponseTimelineEventResponseWithErrors
- Cnange type from
ErrorCategory
tostring
incrm/timeline/models/StandardError::category
. - Nullable
options
incrm/timeline/models/TimelineEventTemplateToken
andcodegen/crm/timeline/models/TimelineEventTemplateTokenUpdateRequest
. - Required
links
infiles/models/FolderUpdateTaskLocator
andfiles/models/ImportFromUrlTaskLocator
. - Nullable
duplicateValidationStrategy
,duplicateValidationScope
andoverwrite
infiles/models/ImportFromUrlInput
. - Cnange type from
ErrorCategory
tostring
infiles/models/StandardError::category
. - Move method
archive
frommarketing.events.marketingEventsExternalApi
tomarketing.events.basicApi
. - Move method
create
frommarketing.events.marketingEventsExternalApi
tomarketing.events.basicApi
. - Move method
doCancel
frommarketing.events.marketingEventsExternalApi
tomarketing.events.basicApi
. - Move method
getById
frommarketing.events.marketingEventsExternalApi
tomarketing.events.basicApi
. - Move method
replace
frommarketing.events.marketingEventsExternalApi
tomarketing.events.basicApi
. - Move method
update
frommarketing.events.marketingEventsExternalApi
tomarketing.events.basicApi
. - Move method
archiveBatch
frommarketing.events.marketingEventsExternalApi
tomarketing.events.batchApi
. - Move method
doUpsert
frommarketing.events.marketingEventsExternalApi
tomarketing.events.batchApi
. - Move method
doEmailUpsertById
frommarketing.events.marketingEventsExternalApi
tomarketing.events.subscriberStateChanges
. - Move method
doUpsertById
frommarketing.events.marketingEventsExternalApi
tomarketing.events.subscriberStateChanges
. - Rename
marketing.events.settingsExternalApi
=>marketing.events.settingsApi
- Cnange type from
ErrorCategory
tostring
inmarketing/events/models/StandardError::category
.
Added
- Added param
prev
tocms/audit_logs/models/PreviousPage
. - Added param
properties
tocms.sourceCode.metadataApi.get()
. - Added param
hash
tocms/source_code/models/AssetFileMetadata
. - Added method
getMetadata
tofiles.filesApi
. - Added param
expiresAt
tofiles/models/FileUpdateInput
andfiles/models/ModelFile
. - Added params
roleIds
,sendWelcomeEmail
andsuperAdmin
tosettings/users/models/PublicUser
9.1.1
Merge pull request #397 from HubSpot/feature/9.1.1 9.1.1
9.1.0
Removed hapikey
from
automation.actions.callbacksApi
Api.cms
(all Api clients).communicationPreferences
(all Api clients).conversations
(all API clients).crm
(all Api clients).events
(all Api clients).files
(all Api clients).marketing.events.settingsExternalApi
Api.marketing.transactional
Api client.
Updated
- Cnange type from
object
tostring
incms/hubdb/models/StandardError.category
. - Cnange type from
StandardError[]
toStandardError1[]
incrm/associations/v4/models/BatchResponseSimplePublicObjectWithErrors::errors
. - Cnange type from
ErrorCategory
tostring
incrm/companies/models/StandardError::category
. - Cnange type from
ErrorCategory
tostring
incrm/contacts/models/StandardError::category
. - Cnange type from
ErrorCategory
tostring
incrm/deals/models/StandardError::category
. - Cnange type from
ErrorCategory
tostring
incrm/lineitems/models/StandardError::category
. - Cnange type from
ErrorCategory
tostring
incrm/objects/calls/models/StandardError::category
. - Cnange type from
ErrorCategory
tostring
incrm/objects/communications/models/StandardError::category
. - Cnange type from
ErrorCategory
tostring
incrm/objects/emails/models/StandardError::category
. - Cnange type from
ErrorCategory
tostring
incrm/objects/feedback_submissions/models/StandardError::category
. - Cnange type from
ErrorCategory
tostring
incrm/objects/meetings/models/StandardError::category
. - Cnange type from
ErrorCategory
tostring
incrm/objects/models/StandardError::category
. - Cnange type from
ErrorCategory
tostring
incrm/objects/notes/models/StandardError::category
. - Cnange type from
ErrorCategory
tostring
incrm/objects/postal_mail/models/StandardError::category
. - Cnange type from
ErrorCategory
tostring
incrm/objects/tasks/models/StandardError::category
. - Cnange type from
ErrorCategory
tostring
incrm/products/models/StandardError::category
. - Cnange type from
ErrorCategory
tostring
incrm/properties/models/StandardError::category
. - Cnange type from
ErrorCategory
tostring
incrm/quotes/models/StandardError::category
. - Cnange type from
ErrorCategory
tostring
incrm/tickets/models/StandardError::category
.
9.0.0
Stable version.
Update associations clients
Added
- crm.associations.v4.basicApi Api.
Updated
- crm.associations.typesApi => crm.associations.schema.typesApi.
- crm.associations.v4.definitionsApi => crm.associations.v4.schema.definitionsApi.
- Removed deprecated webhooks.validateSignature() method.
Add ability to change http agent (7.2.0).
Merge pull request #367 from HubSpot/feature/bumpVersion7.2.0 7.2.0
Add ability to change http agent.
Merge pull request #365 from HubSpot/feature/9.0.0-beta.2 9.0.0-beta.2