Class: HubSpotSDK::Models::Crm::PublicTimePointOperation

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• HubSpotSDK::Models::Crm::PublicTimePointOperation

Defined in:

lib/hubspot_sdk/models/crm/public_time_point_operation.rb

Defined Under Namespace

Modules: OperationType, TimePoint

Instance Attribute Summary

• #endpoint_behavior ⇒ String^?

  Describes the behavior at the endpoint of the time point operation.

• #include_objects_with_no_value_set ⇒ Boolean

  Indicates whether objects with no value set for the property should be included in the operation.

• #operation_type ⇒ Symbol, HubSpotSDK::Models::Crm::PublicTimePointOperation::OperationType

  Specifies the type of operation (TIME_POINT).

• #operator ⇒ String

  Specifies the operation to be applied within the time point operation (IS_BEFORE, IS_AFTER).

• #property_parser ⇒ String^?

  Specifies the parser used for interpreting the property in the operation.

• #time_point ⇒ HubSpotSDK::Models::Crm::PublicDatePoint, ...

  Defines the specific point in time for the operation, which can be a date, indexed time, or property-referenced time.

• #type ⇒ String

  Defines the type of operation being performed.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(include_objects_with_no_value_set:, operation_type:, operator:, time_point:, type:, endpoint_behavior: nil, property_parser: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see PublicTimePointOperation for more details.

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, 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

#initialize(include_objects_with_no_value_set:, operation_type:, operator:, time_point:, type:, endpoint_behavior: nil, property_parser: nil) ⇒ Object

Some parameter documentations has been truncated, see HubSpotSDK::Models::Crm::PublicTimePointOperation for more details.

Parameters:

• include_objects_with_no_value_set (Boolean) —

  Indicates whether objects with no value set for the property should be included

• operation_type (Symbol, HubSpotSDK::Models::Crm::PublicTimePointOperation::OperationType) —

  Specifies the type of operation (TIME_POINT).

• operator (String) —

  Specifies the operation to be applied within the time point operation (IS_BEFORE

• time_point (HubSpotSDK::Models::Crm::PublicDatePoint, HubSpotSDK::Models::Crm::PublicIndexedTimePoint, HubSpotSDK::Models::Crm::PublicPropertyReferencedTime) —

  Defines the specific point in time for the operation, which can be a date, index

• type (String) —

  Defines the type of operation being performed.

• endpoint_behavior (String) (defaults to: nil) —

  Describes the behavior at the endpoint of the time point operation.

• property_parser (String) (defaults to: nil) —

  Specifies the parser used for interpreting the property in the operation.

# File 'lib/hubspot_sdk/models/crm/public_time_point_operation.rb', line 58

Instance Attribute Details

#endpoint_behavior ⇒ String^?

Describes the behavior at the endpoint of the time point operation.

Returns:

• (String, nil)

# File 'lib/hubspot_sdk/models/crm/public_time_point_operation.rb', line 50

optional :endpoint_behavior, String, api_name: :endpointBehavior

#include_objects_with_no_value_set ⇒ Boolean

Indicates whether objects with no value set for the property should be included in the operation.

Returns:

• (Boolean)

# File 'lib/hubspot_sdk/models/crm/public_time_point_operation.rb', line 12

required :include_objects_with_no_value_set,
HubSpotSDK::Internal::Type::Boolean,
api_name: :includeObjectsWithNoValueSet

#operation_type ⇒ Symbol, HubSpotSDK::Models::Crm::PublicTimePointOperation::OperationType

Specifies the type of operation (TIME_POINT).

Returns:

• (Symbol, HubSpotSDK::Models::Crm::PublicTimePointOperation::OperationType)

# File 'lib/hubspot_sdk/models/crm/public_time_point_operation.rb', line 20

required :operation_type,
enum: -> { HubSpotSDK::Crm::PublicTimePointOperation::OperationType },
api_name: :operationType

#operator ⇒ String

Specifies the operation to be applied within the time point operation (IS_BEFORE, IS_AFTER).

Returns:

• (String)

# File 'lib/hubspot_sdk/models/crm/public_time_point_operation.rb', line 29

required :operator, String

#property_parser ⇒ String^?

Specifies the parser used for interpreting the property in the operation.

Returns:

• (String, nil)

# File 'lib/hubspot_sdk/models/crm/public_time_point_operation.rb', line 56

optional :property_parser, String, api_name: :propertyParser

#time_point ⇒ HubSpotSDK::Models::Crm::PublicDatePoint, ...

Defines the specific point in time for the operation, which can be a date, indexed time, or property-referenced time.

Returns:

• (HubSpotSDK::Models::Crm::PublicDatePoint, HubSpotSDK::Models::Crm::PublicIndexedTimePoint, HubSpotSDK::Models::Crm::PublicPropertyReferencedTime)

# File 'lib/hubspot_sdk/models/crm/public_time_point_operation.rb', line 36

required :time_point,
union: -> { HubSpotSDK::Crm::PublicTimePointOperation::TimePoint },
api_name: :timePoint

#type ⇒ String

Defines the type of operation being performed.

Returns:

• (String)

# File 'lib/hubspot_sdk/models/crm/public_time_point_operation.rb', line 44

required :type, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/hubspot_sdk/models/crm/public_time_point_operation.rb', line 84