18.0.0

Changes in Cms AuditLogs API:

• Added new param prev to cms.audit_log.models.Paging.
• Added new param meta to cms.audit_log.models.PublicAuditLog.
• Added cms.audit_logs.models.PreviousPage.

Changes in Automation Actions Definitions API:

• Updated create() method to accept public_action_definition_egg instead of extension_action_definition_input and returned PublicActionDefinition instead ExtensionActionDefinition.
• Updated get_by_id() method to return PublicActionDefinition instead of ExtensionActionDefinition.
• Updated get_page() method to return CollectionResponsePublicActionDefinitionForwardPaging instead of CollectionResponseExtensionActionDefinitionForwardPaging.
• Updated update() method to accept public_action_definition_patch instead of extension_action_definition_patch and returned PublicActionDefinition instead ExtensionActionDefinition.

Changes in Automation Actions Functions API:

• Added new function type POST_ACTION_EXECUTION to all methods.
• Updated create_or_replace() method to return PublicActionFunctionIdentifier instead of ActionFunctionIdentifier.
• Updated create_or_replace_by_function_type() method to return PublicActionFunctionIdentifier instead of ActionFunctionIdentifier.
• Updated get_by_function_type() method to return PublicActionFunction instead of ActionFunction.
• Updated get_by_id() method to return PublicActionFunction instead of ActionFunction.
• Updated get_page() method to return CollectionResponsePublicActionFunctionIdentifierNoPaging instead of CollectionResponseActionFunctionIdentifierNoPaging.

Changes in Automation Actions Revisions API:

• Updated get_by_id() method to return PublicActionRevision instead of ActionRevision.
• Updated get_page() method to return CollectionResponsePublicActionRevisionForwardPaging instead of CollectionResponseActionRevisionForwardPaging.

Changes in Automation Actions Models:

• Added new param automation_field_type to automation.actions.models.InputFieldDefinition.
• Added automation.actions.models.OutputFieldDefinition.
• Added automation.actions.models.PublicExecutionTranslationRule.
• Update params to automation.actions.models.FieldTypeDefinition:

  {
    :'help_text' => :'String',
    :'referenced_object_type' => :'String',
    :'name' => :'String',
    :'options' => :'Array<Option>',
    :'description' => :'String',
    :'external_options_reference_type' => :'String',
    :'label' => :'String',
    :'type' => :'String',
    :'field_type' => :'String',
    :'options_url' => :'String',
    :'external_options' => :'Boolean'
  }

Changes in CMS Blog APIs:

• Updated attach_to_lang_group(), detach_from_lang_group() and update_langs() methods to return nil instead of Error.
• Added new param property to cms.blogs.authors.blog_authors_api.get_by_id() and cms.blogs.authors.blog_authors_api.get_page().

Changes in Blog Models:

• Removed EnumAttributeValidator from a few models blogs: authors, blog_posts, tags.

Changes in CMS Source Code API:

• Renamed method from cms.source_code.content_api.get() to cms.source_code.content_api.download().
• Renamed method from cms.source_code.content_api.replace() to cms.source_code.content_api.create_or_update().
• Added new param hash to cms.source_code.models.AssetFileMetadata.
• Added new param properties to cms.source_code.metadata_api.get().

Changes in CRM Associations API (associations) v4:

• Methods archive(), create() and create_default() of class BasicApi now accept parameters object_id and to_object_id of type string instead of int.
• Method get_page() of class BasicApi now accepts parameter object_id of type string instead of int.
• Changed the type of parameters to_object_id and from_object_id in class LabelsBetweenObjectPair to string.
• Changed the type of parameter to_object_id in class MultiAssociatedObjectWithLabel to string.
• Changed the type of property category in class ErrorCategory to string.

Changes in AssociationsV4 Models:

• Changed the type of property errors in class BatchResponsePublicDefaultAssociation from StandardError1[] to StandardError[].
• Added parameter inverseLabel to classes PublicAssociationDefinitionCreateRequest and PublicAssociationDefinitionUpdateRequest.

Changes in AssociationsV3 Models:

• Changed the type of parameter category from ErrorCategory to string in class StandardError.

Changes in Schema API Methods:

• Method delete() renamed to archive() in class DefinitionsApi.

Changes in Oauth Models:

• Removed params scope_to_scope_group_pks, trial_scopes, trial_scope_to_scope_group_pks from AccessTokenInfoResponse.

Changes in CRM Imports Model:

• Added import_template and import_source params to class PublicImportResponse.

Changes in CRM Lists Memberships API:

• Renamed method add_remove() to add_and_remove().

Changes in CRM Pipelines Pipelines API :

• Added param validate_deal_stage_usages_before_delete to archive(), replace() and update() methods.

Changes in CRM Pipelines Model:

• Added write_permissions param to class PipelineStage.

Changes in CRM Schemas Models:

• Added description param to class ObjectTypeDefinitionPatch.
• Added new params: option_sort_strategy, show_currency_symbol, form_field, referenced_object_type, text_display_hint, searchable_in_global_search
  and number_display_hint to class ObjectTypePropertyCreate.

Changes in CRM Timeline Events API:

• Updated create_batch() method to return nil insted BatchResponseTimelineEventResponse.

Changes in CRM Timeline Model:

• Changed the type of parameter category from ErrorCategory to string in class StandardError.

Changes in CRM Extensions Cards API:

• Changed parameter order in archive() method from (app_id, card_id) to (card_id, app_id).
• Changed parameter order in get_by_id() method from (app_id, card_id) to (card_id, app_id) and method return PublicCardResponse instead CardResponse.
• Changed parameter order in update() method from (app_id, card_id, card_patch_request) to (card_id, app_id, card_patch_request) and method return PublicCardResponse instead CardResponse.
• Updated create() method to return PublicCardResponse instead CardResponse.
• Updated get_all() method to return PublicCardListResponse instead CardListResponse.

Changes in CRM Extensions Card Models:

• Added new params serverless_function and card_type to CardFetchBody and CardFetchBodyPatch.
• Added new param audit_history to PublicCardResponse.
• Added new allowable value marketing_events to CardObjectTypeBody.

Changes in CRM Extensions Videoconferencing API:

• Added developer_hapikey

Changes in CRM Extensions Videoconferencing Model:

• Added new param fetch_accounts_uri to ExternalSettings.

Changes in Events Send API:

• Renamed behavioral_events_tracking_api to custom_event_data_api.

Changes in Events Model:

• Added new param prev to Paging.

Changes in Files Files API:

• Added new method get_metadata().

Changes in Files Models:

• Added new param expires_at to File and FileUpdateInput.
• Changed the type of parameter category from ErrorCategory to string in class StandardError.

Changes in Files Client:

• Moved client from files.files to files.

Changes in Marketing Events APIs:

• Moved methods archive(), create(), do_cancel(), get_by_id(), replace() and update() from marketing.events.marketing_events_external_api to marketing.events.basic_api.
• Moved method do_upsert() from marketing.events.marketing_events_external_api to marketing.events.batch_api.
• Moved and renamed method archive_batch() to archive() from marketing.events.marketing_events_external_api.archive_batch to marketing.events.batch_api.archive.
• Moved methods do_email_upsert_by_id() and do_upsert_by_id() from marketing.events.marketing_events_external_api to marketing.events.subscriber_state_changes.
• Renamed Api marketing.events.settings_external_api to marketing.events.settings_api.

Changes in Marketing Events Models:

• Added new param is_large_value to PropertyValue.
• Changed the type of parameter category from ErrorCategory to string in class StandardError.

Changes in Marketing Forms Models:

• Added new param lifecycle_stages to HubSpotFormConfiguration.

Changes in Settings Users Model:

• Added new params role_ids, send_welcome_email and super_admin to PublicUser.

Changes in All Models PublicObjectSearchRequest:

• Changed the type of parameter after from int to string.

Changes in All Models SimplePublicObjectBatchInput:

• Added new param id_property.

Changes in Crm Objects:

• Removed crm.objects.associations_api.

Changes in Crm Objects Postal Mail BasicAPI:

• Renamed param postal_mail to postal_mail_id

Added new Client APIs:

• Added crm.extensions.calling.recording_settings_api Api.
• Added crm.objects.line_items.gdpr_api Api.
• Added crm.objects.products.gdpr_api Api.
• Added crm.objects.quotes.gdpr_api Api.
• Added crm.objects.tickets.gdpr_api Api.
• Added crm.objects.calls.gdpr_api Api.
• Added crm.objects.emails.gdpr_api Api.
• Added crm.objects.meetings.gdpr_api Api.
• Added crm.objects.notes.gdpr_api Api.
• Added crm.objects.postal_mail.gdpr_api Api.
• Added crm.objects.tasks.gdpr_api Api.
• Added crm.objects.feedback_submissions.gdpr_api Api.
• Added crm.objects.communications.gdpr_api Api.
• Added `marketing.event...

17.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.business_units Api client.

fix initializing `developer_hapikey`

Merge pull request #260 from HubSpot/feature/17.1.1

17.1.1

17.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 to string in cms/hubdb/models/StandardError::category.
• Cnange type from StandardError[] to StandardError1[] in crm/associations/v4/models/BatchResponseSimplePublicObjectWithErrors::errors.
• Cnange type from ErrorCategory to string in crm/companies/models/StandardError::category.
• Cnange type from ErrorCategory to string in crm/contacts/models/StandardError::category.
• Cnange type from ErrorCategory to string in crm/deals/models/StandardError::category.
• Cnange type from ErrorCategory to string in crm/lineitems/models/StandardError::category.
• Cnange type from ErrorCategory to string in crm/objects/calls/models/StandardError::category.
• Cnange type from ErrorCategory to string in crm/objects/communications/models/StandardError::category.
• Cnange type from ErrorCategory to string in crm/objects/emails/models/StandardError::category.
• Cnange type from ErrorCategory to string in crm/objects/feedback_submissions/models/StandardError::category.
• Cnange type from ErrorCategory to string in crm/objects/meetings/models/StandardError::category.
• Cnange type from ErrorCategory to string in crm/objects/models/StandardError::category.
• Cnange type from ErrorCategory to string in crm/objects/notes/models/StandardError::category.
• Cnange type from ErrorCategory to string in crm/objects/postal_mail/models/StandardError::category.
• Cnange type from ErrorCategory to string in crm/objects/tasks/models/StandardError::category.
• Cnange type from ErrorCategory to string in crm/products/models/StandardError::category.
• Cnange type from ErrorCategory to string in crm/properties/models/StandardError::category.
• Cnange type from ErrorCategory to string in crm/quotes/models/StandardError::category.
• Cnange type from ErrorCategory to string in crm/tickets/models/StandardError::category.
• Cnange type from ErrorCategory to string in webhooks/models/StandardError::category.

Fixed

• Hubspot::Helpers::Path.require_with_codegen_mapping()

v17.0.0

Fix Hubspot::OAuthHelper.authorize_url() (don't add empty scopes or optional scopes to OAuth url)

Removed deprecated webhooks helpers.

Removed deprecated webhooks helpers.
add more association types
add custom exceptions for Signature

Update associations and Add communications API

Added

• crm.objects.communications Api client.
• crm.associations.v4.basic_api Api.

Updated

• crm.associations.types_api => crm.associations.schema.types_api
• crm.associations.v4.definitions_api => crm.associations.v4.chema.definitions_api.

Add new event types to webhooks

Merge pull request #231 from HubSpot/feature/17.0.0-beta-2

17.0.0-beta.2

Major version (Breaking changes)

• Rename cms.hubdb.rows_batch_api.batch_clone_draft_table_rows -> cms.hubdb.rows_batch_api.clone_draft_table_rows.
• Rename cms.hubdb.rows_batch_api.batch_create_draft_table_rows -> cms.hubdb.rows_batch_api.create_draft_table_rows.
• Rename cms.hubdb.rows_batch_api.batch_purge_draft_table_rows -> cms.hubdb.rows_batch_api.purge_draft_table_rows.
• Rename cms.hubdb.rows_batch_api.batch_ReadDrafttable_rows -> cms.hubdb.rows_batch_api.read_draft_table_rows.
• Rename cms.hubdb.rows_batch_api.batch_read_table_rows -> cms.hubdb.rows_batch_api.read_table_rows.
• Rename cms.hubdb.rows_batch_api.batch_replace_draft_table_rows -> cms.hubdb.rows_batch_api.replace_draft_table_rows.
• Rename cms.hubdb.rows_batch_api.batch_update_draft_table_rows -> cms.hubdb.rows_batch_api.update_draft_table_rows.
• cms.hubdb.tables_api.get_draft_table_details_by_id -> cms.hubdb.tables_api.get_draft_table_details_by_id(+include_foreign_ids: bool)
• cms.hubdb.tables_api.get_table_details -> cms.hubdb.tables_api.get_table_details(+include_foreign_ids: bool)
• cms.hubdb.tables_api.update_draft_table -> cms.hubdb.tables_api.update_draft_table(+include_foreign_ids: bool)
• Removed crm.companies.associations_api.
• Removed crm.contacts.associations_api.
• Removed crm.deals.associations_api.
• Removed crm.line_items.associations_api.
• Removed crm.objects.calls.associations_api.
• Removed crm.objects.emails.associations_api.
• Removed crm.objects.feedback_submissions.associations_api.
• Removed crm.objects.meetings.associations_api.
• Removed crm.objects.notes.associations_api.
• Removed crm.objects.postal_mail.associations_api.
• Removed crm.objects.tasks.associations_api.
• Removed crm.products.associations_api.
• Removed crm.quotes.associations_api.
• Removed crm.tickets.associations_api.
• crm.companies.basic_api.create(SimplePublicObjectInput -> SimplePublicObjectInputForCreate)
• crm.companies.batch_api.create(BatchInputSimplePublicObjectInput -> BatchInputSimplePublicObjectInputForCreate)
• crm.contacts.basic_api.create(SimplePublicObjectInput -> SimplePublicObjectInputForCreate)
• crm.contacts.batch_api.create(BatchInputSimplePublicObjectInput -> BatchInputSimplePublicObjectInputForCreate)
• crm.deals.basic_api.create(SimplePublicObjectInput -> SimplePublicObjectInputForCreate)
• crm.deals.batch_api.create(BatchInputSimplePublicObjectInput -> BatchInputSimplePublicObjectInputForCreate)
• crm.line_items.basic_api.create(SimplePublicObjectInput -> SimplePublicObjectInputForCreate)
• crm.line_items.batch_api.create(BatchInputSimplePublicObjectInput -> BatchInputSimplePublicObjectInputForCreate)
• crm.objects.basic_api.create(SimplePublicObjectInput -> SimplePublicObjectInputForCreate)
• crm.objects.batch_api.create(BatchInputSimplePublicObjectInput -> BatchInputSimplePublicObjectInputForCreate)
• crm.objects.calls.basic_api.create(SimplePublicObjectInput -> SimplePublicObjectInputForCreate)
• crm.objects.calls.batch_api.create(BatchInputSimplePublicObjectInput -> BatchInputSimplePublicObjectInputForCreate)
• crm.objects.emails.basic_api.create(SimplePublicObjectInput -> SimplePublicObjectInputForCreate)
• crm.objects.emails.batch_api.create(BatchInputSimplePublicObjectInput -> BatchInputSimplePublicObjectInputForCreate)
• crm.objects.feedback_submissions.basic_api.create(SimplePublicObjectInput -> SimplePublicObjectInputForCreate)
• crm.objects.feedback_submissions.batch_api.create(BatchInputSimplePublicObjectInput -> BatchInputSimplePublicObjectInputForCreate)
• crm.objects.meetings.basic_api.create(SimplePublicObjectInput -> SimplePublicObjectInputForCreate)
• crm.objects.meetings.batch_api.create(BatchInputSimplePublicObjectInput -> BatchInputSimplePublicObjectInputForCreate)
• crm.objects.notes.basic_api.create(SimplePublicObjectInput -> SimplePublicObjectInputForCreate)
• crm.objects.notes.batch_api.create(BatchInputSimplePublicObjectInput -> BatchInputSimplePublicObjectInputForCreate)
• crm.objects.postal_mail.basic_api.create(SimplePublicObjectInput -> SimplePublicObjectInputForCreate)
• crm.objects.postal_mail.batch_api.create(BatchInputSimplePublicObjectInput -> BatchInputSimplePublicObjectInputForCreate)
• crm.objects.tasks.basic_api.create(SimplePublicObjectInput -> SimplePublicObjectInputForCreate)
• crm.objects.tasks.batch_api.create(BatchInputSimplePublicObjectInput -> BatchInputSimplePublicObjectInputForCreate)
• crm.objects.products.basic_api.create(SimplePublicObjectInput -> SimplePublicObjectInputForCreate)
• crm.objects.products.batch_api.create(BatchInputSimplePublicObjectInput -> BatchInputSimplePublicObjectInputForCreate)
• crm.objects.quotes.basic_api.create(SimplePublicObjectInput -> SimplePublicObjectInputForCreate)
• crm.objects.quotes.batch_api.create(BatchInputSimplePublicObjectInput -> BatchInputSimplePublicObjectInputForCreate)
• crm.objects.tickets.basic_api.create(SimplePublicObjectInput -> SimplePublicObjectInputForCreate)
• crm.objects.tickets.batch_api.create(BatchInputSimplePublicObjectInput -> BatchInputSimplePublicObjectInputForCreate)
• marketing.events.marketing_events_external_api.do_search -> marketing.events.search_api.do_search
• Rename oauth.access_tokens_api.get_accessToken -> oauth.access_tokens_api.get.
• Rename oauth.refresh_tokens_api.archive_refresh_token -> oauth.refresh_tokens_api.archive.
• Rename oauth.refresh_tokens_api.get_refreshToken -> oauth.refresh_tokens_api.get.
• Rename oauth.tokens_api.create_token -> oauth.tokens_api.create.
• Added param properties to crm.properties.core_api.get_all.
• Added param properties to crm.properties.core_api.get_by_name.
• Added high_value param to all Filters.

Update models for crm.properties API client

Merge pull request #220 from HubSpot/feature/16.4.0

16.4.0