Class: Stripe::WebhookEndpoint::CreateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/resources/webhook_endpoint.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(api_version: nil, connect: nil, description: nil, enabled_events: nil, expand: nil, metadata: nil, url: nil) ⇒ CreateParams

Returns a new instance of CreateParams.



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/stripe/resources/webhook_endpoint.rb', line 114

def initialize(
  api_version: nil,
  connect: nil,
  description: nil,
  enabled_events: nil,
  expand: nil,
  metadata: nil,
  url: nil
)
  @api_version = api_version
  @connect = connect
  @description = description
  @enabled_events = enabled_events
  @expand = expand
  @metadata = metadata
  @url = url
end

Instance Attribute Details

#api_version ⇒ Object

Events sent to this endpoint will be generated with this Stripe Version instead of your account’s default Stripe Version.



94
95
96
 
# File 'lib/stripe/resources/webhook_endpoint.rb', line 94

def api_version
  @api_version
end

#connect ⇒ Object

Whether this endpoint should receive events from connected accounts (‘true`), or from your account (`false`). Defaults to `false`.



97
98
99
 
# File 'lib/stripe/resources/webhook_endpoint.rb', line 97

def connect
  @connect
end

#description ⇒ Object

An optional description of what the webhook is used for.



100
101
102
 
# File 'lib/stripe/resources/webhook_endpoint.rb', line 100

def description
  @description
end

#enabled_events ⇒ Object

The list of events to enable for this endpoint. You may specify ‘[’*‘]` to enable all events, except those that require explicit selection.



103
104
105
 
# File 'lib/stripe/resources/webhook_endpoint.rb', line 103

def enabled_events
  @enabled_events
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



106
107
108
 
# File 'lib/stripe/resources/webhook_endpoint.rb', line 106

def expand
  @expand
end

#metadata ⇒ Object

Set of [key-value pairs](stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to ‘metadata`.



109
110
111
 
# File 'lib/stripe/resources/webhook_endpoint.rb', line 109

def metadata
  @metadata
end

#url ⇒ Object

The URL of the webhook endpoint.



112
113
114
 
# File 'lib/stripe/resources/webhook_endpoint.rb', line 112

def url
  @url
end