Class: Io::Flow::V0::Models::WebhookSettings

Inherits:
Object
  • Object
show all
Defined in:
lib/flow_commerce/flow_api_v0_client.rb

Overview

Sets organization level settings to determine things like how many retries on delivery, how long we wait, etc. By default, we will attempt delivery up to 6 times, using exponential backoff with a see of 1 minute (60k ms) - which means that we will retry over the course of approximately an hour before giving up.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(incoming = {}) ⇒ WebhookSettings

Returns a new instance of WebhookSettings.



26616
26617
26618
26619
26620
26621
26622
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 26616

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  @secret = (x = opts.delete(:secret); x.nil? ? nil : HttpClient::Preconditions.assert_class('secret', x, String))
  @retry_max_attempts = HttpClient::Preconditions.assert_class('retry_max_attempts', (x = opts.delete(:retry_max_attempts); x.nil? ? 6 : x), Integer)
  @retry_sleep_ms = HttpClient::Preconditions.assert_class('retry_sleep_ms', (x = opts.delete(:retry_sleep_ms); x.nil? ? 60000 : x), Integer)
  @sleep_ms = HttpClient::Preconditions.assert_class('sleep_ms', (x = opts.delete(:sleep_ms); x.nil? ? 0 : x), Integer)
end

Instance Attribute Details

#retry_max_attempts ⇒ Object (readonly)

Returns the value of attribute retry_max_attempts.



26614
26615
26616
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 26614

def retry_max_attempts
  @retry_max_attempts
end

#retry_sleep_ms ⇒ Object (readonly)

Returns the value of attribute retry_sleep_ms.



26614
26615
26616
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 26614

def retry_sleep_ms
  @retry_sleep_ms
end

#secret ⇒ Object (readonly)

Returns the value of attribute secret.



26614
26615
26616
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 26614

def secret
  @secret
end

#sleep_ms ⇒ Object (readonly)

Returns the value of attribute sleep_ms.



26614
26615
26616
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 26614

def sleep_ms
  @sleep_ms
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



26628
26629
26630
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 26628

def copy(incoming={})
  WebhookSettings.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming)))
end

#to_hash ⇒ Object 



26632
26633
26634
26635
26636
26637
26638
26639
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 26632

def to_hash
  {
    :secret => secret,
    :retry_max_attempts => retry_max_attempts,
    :retry_sleep_ms => retry_sleep_ms,
    :sleep_ms => sleep_ms
  }
end

#to_json ⇒ Object 



26624
26625
26626
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 26624

def to_json
  JSON.dump(to_hash)
end