Class: SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/safety_kit/models/beta/event_create_params.rb

Defined Under Namespace

Modules: Content, EventName, Metadata, Type Classes: Product, ResourcesUsed

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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(ships_from:, ships_to:) ⇒ Object

Shipping details for the product.

Parameters:

  • ships_from (String) —

    Location the product ships from.

  • ships_to (Array<String>) —

    Locations the product ships to.




# File 'lib/safety_kit/models/beta/event_create_params.rb', line 730

Instance Attribute Details

#content ⇒ Array<SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::Content::EventImageContent>

User-authored or user-uploaded content parts. Use this for message bodies, bios, listing text, image URLs, and similar content SafetyKit should compare or analyze.

Returns:



666
667
 
# File 'lib/safety_kit/models/beta/event_create_params.rb', line 666

required :content,
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::ProductChangedEventRequest::Content] }

#content_id ⇒ String?

Your stable identifier for the content involved in this event, such as a message, listing, page, post, profile, or uploaded media item.

Returns:

  • (String, nil) 


704
 
# File 'lib/safety_kit/models/beta/event_create_params.rb', line 704

optional :content_id, String

#event_name ⇒ Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::EventName

Product action that triggered this event.

Returns:



673
674
 
# File 'lib/safety_kit/models/beta/event_create_params.rb', line 673

required :event_name,
enum: -> { SafetyKit::Beta::EventCreateParams::Body::ProductChangedEventRequest::EventName }

#idempotency_key ⇒ String?

Optional caller-provided key used to make retries of this individual event idempotent. Reuse the same key only for retries of the same logical event.

Returns:

  • (String, nil) 


711
 
# File 'lib/safety_kit/models/beta/event_create_params.rb', line 711

optional :idempotency_key, String

#metadata ⇒ Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}?

Non-PII product context for filtering, segmentation, and debugging. Values may be strings, numbers, booleans, or arrays of those scalar values.

Returns:

  • (Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil) 


718
719
 
# File 'lib/safety_kit/models/beta/event_create_params.rb', line 718

optional :metadata,
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::ProductChangedEventRequest::Metadata] }

#product ⇒ SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::Product

Commerce details for the product involved in this event.

Returns:



680
 
# File 'lib/safety_kit/models/beta/event_create_params.rb', line 680

required :product, -> { SafetyKit::Beta::EventCreateParams::Body::ProductChangedEventRequest::Product }

#resources_used ⇒ Array<SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::ResourcesUsed>?

Reusable resources observed during the event. Use this for emails, phone numbers, names, addresses, social handles, URLs, payment identifiers, or similar identifiers.

Returns:



727
728
 
# File 'lib/safety_kit/models/beta/event_create_params.rb', line 727

optional :resources_used,
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::ProductChangedEventRequest::ResourcesUsed] }

#timestamp ⇒ Time

The time the event occurred in your system, as an ISO 8601 datetime string.

Returns:

  • (Time) 


686
 
# File 'lib/safety_kit/models/beta/event_create_params.rb', line 686

required :timestamp, Time

#type ⇒ Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::Type

Returns:



691
 
# File 'lib/safety_kit/models/beta/event_create_params.rb', line 691

required :type, enum: -> { SafetyKit::Beta::EventCreateParams::Body::ProductChangedEventRequest::Type }

#user_id ⇒ String

Your stable canonical identifier for the user or account.

Returns:

  • (String) 


697
 
# File 'lib/safety_kit/models/beta/event_create_params.rb', line 697

required :user_id, String