Class: Stripe::WebhookEndpointService::CreateParams

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/services/webhook_endpoint_service.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.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/stripe/services/webhook_endpoint_service.rb', line 97

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.



77
78
79
 
# File 'lib/stripe/services/webhook_endpoint_service.rb', line 77

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`.



80
81
82
 
# File 'lib/stripe/services/webhook_endpoint_service.rb', line 80

def connect
  @connect
end

#description ⇒ Object

An optional description of what the webhook is used for.



83
84
85
 
# File 'lib/stripe/services/webhook_endpoint_service.rb', line 83

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.



86
87
88
 
# File 'lib/stripe/services/webhook_endpoint_service.rb', line 86

def enabled_events
  @enabled_events
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



89
90
91
 
# File 'lib/stripe/services/webhook_endpoint_service.rb', line 89

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`.



92
93
94
 
# File 'lib/stripe/services/webhook_endpoint_service.rb', line 92

def metadata
  @metadata
end

#url ⇒ Object

The URL of the webhook endpoint.



95
96
97
 
# File 'lib/stripe/services/webhook_endpoint_service.rb', line 95

def url
  @url
end