Class: HubSpotSDK::Models::Webhooks::SubscriptionResponse1

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/hubspot_sdk/models/webhooks/subscription_response_1.rb

Overview

See Also:

Defined Under Namespace

Modules: Action, SubscriptionType

Instance Attribute Summary collapse

Class Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

This class inherits a constructor from HubSpotSDK::Internal::Type::BaseModel

Instance Attribute Details

#action_overrides ⇒ Hash{Symbol=>HubSpotSDK::Models::Webhooks::ActionOverrideRequest}?

An object containing action overrides, where each key is an action and the value is an ActionOverrideRequest object.

Returns:



65
66
67
 
# File 'lib/hubspot_sdk/models/webhooks/subscription_response_1.rb', line 65

optional :action_overrides,
-> { HubSpotSDK::Internal::Type::HashOf[HubSpotSDK::Webhooks::ActionOverrideRequest] },
api_name: :actionOverrides

#actions ⇒ Array<Symbol, HubSpotSDK::Models::Webhooks::SubscriptionResponse1::Action>

A list of actions that trigger the subscription. Possible values include ‘CREATE’, ‘UPDATE’, ‘DELETE’, ‘MERGE’, ‘RESTORE’, ‘ASSOCIATION_ADDED’, ‘ASSOCIATION_REMOVED’, ‘SNAPSHOT’, ‘APP_INSTALL’, ‘APP_UNINSTALL’, ‘ADDED_TO_LIST’, ‘REMOVED_FROM_LIST’, and ‘GDPR_DELETE’.

Returns:



21
22
 
# File 'lib/hubspot_sdk/models/webhooks/subscription_response_1.rb', line 21

required :actions,
-> { HubSpotSDK::Internal::Type::ArrayOf[enum: HubSpotSDK::Webhooks::SubscriptionResponse1::Action] }

#app_id ⇒ Integer

The unique identifier for the app associated with the subscription. It is an integer formatted as int64.

Returns:

  • (Integer) 


29
 
# File 'lib/hubspot_sdk/models/webhooks/subscription_response_1.rb', line 29

required :app_id, Integer, api_name: :appId

#associated_object_type_ids ⇒ Array<String>?

A list of associated object type IDs. Each ID is a string.

Returns:

  • (Array<String>, nil) 


73
74
75
 
# File 'lib/hubspot_sdk/models/webhooks/subscription_response_1.rb', line 73

optional :associated_object_type_ids,
HubSpotSDK::Internal::Type::ArrayOf[String],
api_name: :associatedObjectTypeIds

#created_at ⇒ Time

The date and time when the subscription was created, in ISO 8601 format.

Returns:

  • (Time) 


35
 
# File 'lib/hubspot_sdk/models/webhooks/subscription_response_1.rb', line 35

required :created_at, Time, api_name: :createdAt

#created_by ⇒ Integer?

The ID of the user who created the subscription. It is an integer formatted as int64.

Returns:

  • (Integer, nil) 


82
 
# File 'lib/hubspot_sdk/models/webhooks/subscription_response_1.rb', line 82

optional :created_by, Integer, api_name: :createdBy

#deleted_at ⇒ Time?

The date and time when the subscription was deleted, in ISO 8601 format, if applicable.

Returns:

  • (Time, nil) 


89
 
# File 'lib/hubspot_sdk/models/webhooks/subscription_response_1.rb', line 89

optional :deleted_at, Time, api_name: :deletedAt

#id ⇒ Integer

The unique identifier for the subscription. It is an integer formatted as int64.

Returns:

  • (Integer) 


12
 
# File 'lib/hubspot_sdk/models/webhooks/subscription_response_1.rb', line 12

required :id, Integer

#list_ids ⇒ Array<Integer>?

A list of list IDs associated with the subscription. Each ID is an integer formatted as int64.

Returns:

  • (Array<Integer>, nil) 


96
 
# File 'lib/hubspot_sdk/models/webhooks/subscription_response_1.rb', line 96

optional :list_ids, HubSpotSDK::Internal::Type::ArrayOf[Integer], api_name: :listIds

#object_ids ⇒ Array<Integer>?

A list of object IDs associated with the subscription. Each ID is an integer formatted as int64.

Returns:

  • (Array<Integer>, nil) 


103
 
# File 'lib/hubspot_sdk/models/webhooks/subscription_response_1.rb', line 103

optional :object_ids, HubSpotSDK::Internal::Type::ArrayOf[Integer], api_name: :objectIds

#object_type_id ⇒ String

The identifier for the object type associated with the subscription. It is a string.

Returns:

  • (String) 


42
 
# File 'lib/hubspot_sdk/models/webhooks/subscription_response_1.rb', line 42

required :object_type_id, String, api_name: :objectTypeId

#portal_id ⇒ Integer?

The unique identifier for the portal associated with the subscription. It is an integer formatted as int64.

Returns:

  • (Integer, nil) 


110
 
# File 'lib/hubspot_sdk/models/webhooks/subscription_response_1.rb', line 110

optional :portal_id, Integer, api_name: :portalId

#properties ⇒ Array<String>?

A list of property names associated with the subscription. Each property is a string.

Returns:

  • (Array<String>, nil) 


117
 
# File 'lib/hubspot_sdk/models/webhooks/subscription_response_1.rb', line 117

optional :properties, HubSpotSDK::Internal::Type::ArrayOf[String]

#subscription_type ⇒ Symbol, HubSpotSDK::Models::Webhooks::SubscriptionResponse1::SubscriptionType

The type of subscription, which can be one of the following: ‘OBJECT’, ‘ASSOCIATION’, ‘EVENT’, ‘APP_LIFECYCLE_EVENT’, ‘LIST_MEMBERSHIP’, or ‘GDPR_PRIVACY_DELETION’.

Returns:



50
51
52
 
# File 'lib/hubspot_sdk/models/webhooks/subscription_response_1.rb', line 50

required :subscription_type,
enum: -> { HubSpotSDK::Webhooks::SubscriptionResponse1::SubscriptionType },
api_name: :subscriptionType

#updated_at ⇒ Time

The date and time when the subscription was last updated, in ISO 8601 format.

Returns:

  • (Time) 


58
 
# File 'lib/hubspot_sdk/models/webhooks/subscription_response_1.rb', line 58

required :updated_at, Time, api_name: :updatedAt

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/hubspot_sdk/models/webhooks/subscription_response_1.rb', line 170