Class: ModerationAPI::Models::WebhookCreateResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/moderation_api/models/webhook_create_response.rb,
sig/moderation_api/models/webhook_create_response.rbs

Overview

See Also:

  • ModerationAPI::Resources::Webhooks#create

Defined Under Namespace

Modules: EventType, PayloadVersion

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 ⇒ Object 



29
 
# File 'sig/moderation_api/models/webhook_create_response.rbs', line 29

def initialize: (

Instance Attribute Details

#created_at ⇒ String

The date the webhook was created.

Parameters:

  • value (String)

Returns:

  • (String) 


17
 
# File 'lib/moderation_api/models/webhook_create_response.rb', line 17

required :created_at, String, api_name: :createdAt

#description ⇒ String?

The webhook's description.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


53
 
# File 'lib/moderation_api/models/webhook_create_response.rb', line 53

optional :description, String, nil?: true

#event_types ⇒ Array<Symbol, ModerationAPI::Models::WebhookCreateResponse::EventType>

Event types this webhook subscribes to. Empty for legacy v1 webhooks, which subscribe via their single deprecated type instead.

Parameters:

  • value (::Array[ModerationAPI::Models::WebhookCreateResponse::event_type])

Returns:



24
25
26
 
# File 'lib/moderation_api/models/webhook_create_response.rb', line 24

required :event_types,
-> { ModerationAPI::Internal::Type::ArrayOf[enum: ModerationAPI::Models::WebhookCreateResponse::EventType] },
api_name: :eventTypes

#id ⇒ String

The ID of the webhook.

Parameters:

  • value (String)

Returns:

  • (String) 


11
 
# File 'lib/moderation_api/models/webhook_create_response.rb', line 11

required :id, String

#name ⇒ String

The webhook's name.

Parameters:

  • value (String)

Returns:

  • (String) 


32
 
# File 'lib/moderation_api/models/webhook_create_response.rb', line 32

required :name, String

#payload_version ⇒ Symbol, ModerationAPI::Models::WebhookCreateResponse::PayloadVersion

Payload envelope version. V2 is the Stripe-style envelope; V1 is the legacy flat shape and is read-only via this API.

Parameters:

  • value (ModerationAPI::Models::WebhookCreateResponse::payload_version)

Returns:



39
40
41
 
# File 'lib/moderation_api/models/webhook_create_response.rb', line 39

required :payload_version,
enum: -> { ModerationAPI::Models::WebhookCreateResponse::PayloadVersion },
api_name: :payloadVersion

#url ⇒ String

The URL we call when a subscribed event occurs.

Parameters:

  • value (String)

Returns:

  • (String) 


47
 
# File 'lib/moderation_api/models/webhook_create_response.rb', line 47

required :url, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/moderation_api/models/webhook_create_response.rb', line 88

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


39
 
# File 'sig/moderation_api/models/webhook_create_response.rbs', line 39

def to_hash: -> {