Releases: HubSpot/hubspot-api-nodejs
Releases · HubSpot/hubspot-api-nodejs
12.0.1
12.0.0
CMS
- Changed type from
string
to laguages enum incms/blogs/blog_posts/models/AttachToLangPrimaryRequestVNext::language
. - Added parameter
campaignName
tocms/blogs/blog_posts/models/ContentLanguageVariation
. - Added parameter
breakpointStyles
tocms/blogs/blog_posts/models/Styles
. - Added parameter
name
tocms.hubdb.rowsApi.cloneDraftTableRow()
. - Added parameter
archived
tocms.hubdb.rowsApi.getDraftTableRowById()
andcms.hubdb.rowsApi.getTableRow()
. - Added parameters
offset
andarchived
tocms.hubdb.rowsApi.getTableRows()
andcms.hubdb.rowsApi.readDraftTableRows()
. - Changed the response object type from
CollectionResponseWithTotalHubDbTableRowV3ForwardPaging
toUnifiedCollectionResponseWithTotalBaseHubDbTableRowV3
forcms.hubdb.rowsApi.getTableRows()
andcms.hubdb.rowsApi.readDraftTableRows()
. - Changed parameter
batchInputString: BatchInputString
tobatchInputHubDbTableRowBatchCloneRequest: BatchInputHubDbTableRowBatchCloneRequest
incms.hubdb.rowsApi.cloneDraftTableRow()
. - Added parameter
contentType
beforearchived
parameter tocms.hubdb.tablesApi.getAllTables()
. - Changed parameters from
tableIdOrName: string, includeForeignIds?: boolean, archived?: boolean
totableIdOrName: string, isGetLocalizedSchema?: boolean, archived?: boolean, includeForeignIds?: boolean
ofcms.hubdb.tablesApi.getDraftTableDetailsById()
andcms.hubdb.tablesApi.getTableDetails()
. - Changed parameters from
tableIdOrName: string, hubDbTableV3Request: HubDbTableV3Request, includeForeignIds?: boolean, archived?: boolean
totableIdOrName: string, hubDbTableV3Request: HubDbTableV3Request, isGetLocalizedSchema?: boolean, archived?: boolean, includeForeignIds?: boolean
ofcms.hubdb.tablesApi.updateDraftTable()
. - Added parameters
createdByUserId
,updatedBy
,updatedByUserId
,createdAt
,createdBy
andupdatedAt
tocms/hubdb/models/Column
andcms/hubdb/models/Option
. - Added the parameter
isHubspotDefined
tocms/hubdb/models/HubDbTableCloneRequest
. - Removed
cms.source_code.ExtractApi.extractByPath()
method. - Added
doAsync()
andgetAsyncStatus()
methods tocms.source_code.ExtractApi
. - Removed
cms.source_code.sourceCodeExtractApi
.
CRM
- Added
crm.associassociations.v4.reportApi
. - Added parameter
idProperty
tocrm.companies.basicApi.getById()
,crm.companies.basicApi.update()
,crm.deals.basicApi.getById()
,crm.deals.basicApi.update()
. - Added method
upsert
tocrm.companies.batchApi
,crm.contacts.batchApi
,crm.deals.batchApi
,crm.line_items.batchApi
,crm.objects.batchApi
,crm.objects.calls.batchApi
,crm.objects.communications.batchApi
,crm.objects.emails.batchApi
,crm.objects.meetings.batchApi
,crm.objects.notes.batchApi
,crm.objects.postal_mail.batchApi
,crm.objects.tasks.batchApi
,crm.objects.taxes.batchApi
,crm.products.batchApi
,crm.quotes.batchApi
,crm.tickets.batchApi
- Removed
crm.companies.GDPRApi
,crm.deals.GDPRApi
,crm.line_items.GDPRApi
,crm.objects.GDPRApi
,crm.objects.calls.GDPRApi
,crm.objects.communications.GDPRApi
,crm.objects.emails.GDPRApi
,crm.objects.feedback_submissions.GDPRApi
,crm.objects.goals.GDPRApi
,crm.objects.meetings.GDPRApi
,crm.objects.notes.GDPRApi
,crm.objects.postal_mail.GDPRApi
,crm.objects.tasks.GDPRApi
,crm.objects.taxes.GDPRApi
,crm.products.GDPRApi
,crm.quotes.GDPRApi
,crm.tickets.GDPRApi
- Removed
crm.line_items.publicObjectApi
,crm.objects.publicObjectApi
,crm.objects.calls.publicObjectApi
,crm.objects.communications.publicObjectApi
,crm.objects.emails.publicObjectApi
,crm.objects.feedback_submissions.publicObjectApi
,crm.objects.goals.publicObjectApi
,crm.objects.meetings.publicObjectApi
,crm.objects.notes.publicObjectApi
,crm.objects.postal_mail.publicObjectApi
,crm.objects.tasks.publicObjectApi
,crm.objects.taxes.publicObjectApi
,crm.products.publicObjectApi
,crm.quotes.publicObjectApi
- Renamed
publicObjectApi
tomergeApi
incrm.companies
,crm.contacts
,crm.deals
andcrm.tickets
. - Made
associationCategory
andassociationTypeId
parameters nullable incrm/companies/models/AssociationSpec
,crm/contacts/models/AssociationSpec
,crm/deals/models/AssociationSpec
,crm/tickets/models/AssociationSpec
. - Made
types
andto
parameters nullable incrm/companies/models/PublicAssociationsForObject
,crm/contacts/models/PublicAssociationsForObject
,crm/deals/models/PublicAssociationsForObject
,crm/tickets/models/PublicAssociationsForObject
. - Made
id
parameter nullable incrm/companies/models/PublicObjectId
,crm/contacts/models/PublicObjectId
,crm/deals/models/PublicObjectId
andcrm/tickets/models/PublicObjectId
. - Made
limit
,after
,sorts
,properties
andfilterGroups
parameters nullable incrm/companies/models/PublicObjectSearchRequest
,crm/contacts/models/PublicObjectSearchRequest
,crm/deals/models/PublicObjectSearchRequest
,crm/line_items/models/PublicObjectSearchRequest
,crm/objects/models/PublicObjectSearchRequest
,crm/objects/calls/models/PublicObjectSearchRequest
,crm/objects/communications/models/PublicObjectSearchRequest
,crm/objects/emails/models/PublicObjectSearchRequest
,crm/objects/feedback_submissions/models/PublicObjectSearchRequest
,crm/objects/goals/models/PublicObjectSearchRequest
,crm/objects/leads/models/PublicObjectSearchRequest
,crm/objects/postal_mail/models/PublicObjectSearchRequest
,crm/objects/tasks/models/PublicObjectSearchRequest
,crm/objects/taxes/models/PublicObjectSearchRequest
,crm/products/models/PublicObjectSearchRequest
,crm/quotes/models/PublicObjectSearchRequest
andcrm/tickets/models/PublicObjectSearchRequest
. - Added parameter
objectWriteTraceId
tocrm/companies/models/SimplePublicObjectBatchInput
,crm/companies/models/SimplePublicObjectInput
,crm/companies/models/SimplePublicObjectInputForCreate
,crm/contacts/models/SimplePublicObjectBatchInput
,crm/contacts/models/SimplePublicObjectInput
,crm/contacts/models/SimplePublicObjectInputForCreate
,crm/deals/models/SimplePublicObjectBatchInput
,crm/deals/models/SimplePublicObjectInput
,crm/deals/models/SimplePublicObjectInputForCreate
,crm/line_items/models/SimplePublicObjectBatchInput
,crm/line_items/models/SimplePublicObjectInput
,crm/line_items/models/SimplePublicObjectInputForCreate
,crm/objects/models/SimplePublicObjectBatchInput
,crm/objects/models/SimplePublicObjectInput
,crm/objects/models/SimplePublicObjectInputForCreate
,crm/objects/calls/models/SimplePublicObjectBatchInput
,crm/objects/calls/models/SimplePublicObjectInput
,crm/objects/calls/models/SimplePublicObjectInputForCreate
,crm/objects/communications/models/SimplePublicObjectBatchInput
,crm/objects/communications/models/SimplePublicObjectInput
,crm/objects/communications/models/SimplePublicObjectInputForCreate
,crm/objects/emails/models/SimplePublicObjectBatchInput
,crm/objects/emails/models/SimplePublicObjectInput
,crm/objects/emails/models/SimplePublicObjectInputForCreate
,crm/objects/leads/models/SimplePublicObjectBatchInput
,crm/objects/leads/models/SimplePublicObjectInput
,crm/objects/leads/models/SimplePublicObjectInputForCreate
,crm/objects/leads/models/SimplePublicObjectBatchInputUpsert
,crm/objects/meetings/models/SimplePublicObjectBatchInput
,crm/objects/meetings/models/SimplePublicObjectInput
,crm/objects/meetings/models/SimplePublicObjectInputForCreate
,crm/objects/notes/models/SimplePublicObjectBatchInput
,crm/objects/notes/models/SimplePublicObjectInput
,crm/objects/notes/models/SimplePublicObjectInputForCreate
,crm/objects/postal_mail/models/SimplePublicObjectBatchInput
,crm/objects/postal_mail/models/SimplePublicObjectInput
,crm/objects/postal_mail/models/SimplePublicObjectInputForCreate
,crm/objects/tasks/models/SimplePublicObjectBatchInput
,crm/objects/tasks/models/SimplePublicObjectInput
,crm/objects/tasks/models/SimplePublicObjectInputForCreate
,crm/objects/taxes/models/SimplePublicObjectBatchInput
,crm/objects/taxes/models/SimplePublicObjectInput
,crm/objects/taxes/models/SimplePublicObjectInputForCreate
,crm/products/models/SimplePublicObjectBatchInput
,crm/products/models/SimplePublicObjectInput
,crm/products/models/SimplePublicObjectInputForCreate
,crm/quotes/models/SimplePublicObjectBatchInput
,crm/quotes/models/SimplePublicObjectInput
,crm/quotes/models/SimplePublicObjectInputForCreate
,crm/tickets/models/SimplePublicObjectBatchInput
,crm/tickets/models/SimplePublicObjectInput
andcrm/tickets/models/SimplePublicObjectInputForCreate
. - Made
associations
parameter nullable incrm/companies/models/SimplePublicObjectInputForCreate
,crm/contacts/models/SimplePublicObjectInputForCreate
,crm/deals/models/SimplePublicObjectInputForCreate
andcrm/tickets/models/SimplePublicObjectInputForCreate
. - Removed
crm.extensions.accounting
API client. - Added method
markAsReady
tocrm.extensions.calling.recordingSettingsApi
. - Added parameter
supportsInboundCalling
tocrm/extensions/calling/models/SettingsPatchRequest
,crm/extensions/calling/models/SettingsRequest
andcrm/extensions/calling/models/SettingsResponse
. - Added parameters
userIdIncludingInactive
andtype
tocrm/owners/models/PublicOwner
. - Removed
archive
,create
andupdate
methods fromcrm.objects.feedback_submissions.basicApi
,crm.objects.feedback_submissions.batchApi
,crm.objects.goals.basicApi
andcrm.objects.goals.batchApi
. - Changed response object type
BatchResponseSimplePublicObject | BatchResponseSimplePublicObjectWithErrors
toBatchResponseSimplePublicUpsertObjectWithErrors | BatchResponseSimplePublicUpsertObject
ofcrm.objects.leads.rowsApi.upsert()
. - Removed
crm.schemas.PublicObjectSchemasApi
. - Added parameters
createdByUserId
andupdatedByUserId
to `crm/schemas/models/ObjectSche...
11.2.0
Changes:
- Added
crm()->objects()->leads()
api client
10.2.1
Fixed automation.actions.functionsApi.createOrReplaceByFunctionType()
method.
11.1.0
Added param idProperty
to SimplePublicObjectBatchInput
in all CRM clients.
11.0.0
Non-breaking changes
- Added param
'inverseLabel'?: string
tocrm/associations/v4/schema/models/PublicAssociationDefinitionCreateRequest
andcrm/associations/v4/schema/models/PublicAssociationDefinitionUpdateRequest
. - Added new association types to
enums/AssociationTypes
.
Breaking changes
crm.associations.v4.basicApi.archive(objectType: string, objectId: number, toObjectType: string, toObjectId: number, _options?: Configuration)
=>crm.associations.v4.basicApi.archive(objectType: string, objectId: string, toObjectType: string, toObjectId: string, _options?: Configuration)
crm.associations.v4.basicApi.create(objectType: string, objectId: number, toObjectType: string, toObjectId: number, associationSpec: Array<AssociationSpec>, _options?: Configuration): Promise<LabelsBetweenObjectPair1>
=>crm.associations.v4.basicApi.create(objectType: string, objectId: string, toObjectType: string, toObjectId: string, associationSpec: Array<AssociationSpec>, _options?: Configuration): Promise<LabelsBetweenObjectPair>
crm.associations.v4.basicApi.createDefault(fromObjectType: string, fromObjectId: number, toObjectType: string, toObjectId: number, _options?: Configuration)
=>crm.associations.v4.basicApi.createDefault(fromObjectType: string, fromObjectId: string, toObjectType: string, toObjectId: string, _options?: Configuration)
crm.associations.v4.basicApi.getPage(objectType: string, objectId: number, toObjectType: string, after?: string, limit?: number, _options?: Configuration)
=>crm.associations.v4.basicApi.getPage(objectType: string, objectId: string, toObjectType: string, after?: string, limit?: number, _options?: Configuration)
- Cnange type from
number
tostring
incrm/associations/v4/models/MultiAssociatedObjectWithLabel::toObjectId
.
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