class UltracartClient::Webhook
Attributes
Populated if webhook associated with an API user
Version of the API objects that are sent in notifications
The type of authentication this webhook will use when communicating with your server
Basic authentication password
Basic authentication user name
The number of consecutive failures that have occurred trying to deliver notifications to the target server
True if the webhook has been disabled
The categories of events. Individual events and subscriptions are handled in the child objects. _placeholders parameter effects the population of this on a retrieval.
IAM Access Key for AWS SQS Delivery
IAM Secret Key for AWS SQS Delivery
The maximum number of events in the payload that UltraCart will deliver
The maximum size of the payload that UltraCart will deliver
The UltraCart merchant ID that owns this webhook
The next time UltraCart will attempt delivery if failures have been occurring
The number of pending events for this webhook
The object identifier for this webhook
The URL to deliver events to. Must be HTTPS for customer related information.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/ultracart_api/models/webhook.rb, line 93 def self.attribute_map { :'api_user_oid' => :'api_user_oid', :'api_version' => :'api_version', :'application_profile' => :'application_profile', :'authentication_type' => :'authentication_type', :'basic_password' => :'basic_password', :'basic_username' => :'basic_username', :'consecutive_failures' => :'consecutive_failures', :'disabled' => :'disabled', :'event_categories' => :'event_categories', :'iam_access_key' => :'iam_access_key', :'iam_secret_key' => :'iam_secret_key', :'maximum_events' => :'maximum_events', :'maximum_size' => :'maximum_size', :'merchant_id' => :'merchant_id', :'next_retry_after' => :'next_retry_after', :'pending' => :'pending', :'webhook_oid' => :'webhook_oid', :'webhook_url' => :'webhook_url' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/ultracart_api/models/webhook.rb, line 142 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } if attributes.has_key?(:'api_user_oid') self.api_user_oid = attributes[:'api_user_oid'] end if attributes.has_key?(:'api_version') self.api_version = attributes[:'api_version'] end if attributes.has_key?(:'application_profile') self.application_profile = attributes[:'application_profile'] end if attributes.has_key?(:'authentication_type') self.authentication_type = attributes[:'authentication_type'] end if attributes.has_key?(:'basic_password') self.basic_password = attributes[:'basic_password'] end if attributes.has_key?(:'basic_username') self.basic_username = attributes[:'basic_username'] end if attributes.has_key?(:'consecutive_failures') self.consecutive_failures = attributes[:'consecutive_failures'] end if attributes.has_key?(:'disabled') self.disabled = attributes[:'disabled'] end if attributes.has_key?(:'event_categories') if (value = attributes[:'event_categories']).is_a?(Array) self.event_categories = value end end if attributes.has_key?(:'iam_access_key') self.iam_access_key = attributes[:'iam_access_key'] end if attributes.has_key?(:'iam_secret_key') self.iam_secret_key = attributes[:'iam_secret_key'] end if attributes.has_key?(:'maximum_events') self.maximum_events = attributes[:'maximum_events'] end if attributes.has_key?(:'maximum_size') self.maximum_size = attributes[:'maximum_size'] end if attributes.has_key?(:'merchant_id') self.merchant_id = attributes[:'merchant_id'] end if attributes.has_key?(:'next_retry_after') self.next_retry_after = attributes[:'next_retry_after'] end if attributes.has_key?(:'pending') self.pending = attributes[:'pending'] end if attributes.has_key?(:'webhook_oid') self.webhook_oid = attributes[:'webhook_oid'] end if attributes.has_key?(:'webhook_url') self.webhook_url = attributes[:'webhook_url'] end end
Attribute type mapping.
# File lib/ultracart_api/models/webhook.rb, line 117 def self.swagger_types { :'api_user_oid' => :'Integer', :'api_version' => :'String', :'application_profile' => :'ApiUserApplicationProfile', :'authentication_type' => :'String', :'basic_password' => :'String', :'basic_username' => :'String', :'consecutive_failures' => :'Integer', :'disabled' => :'BOOLEAN', :'event_categories' => :'Array<WebhookEventCategory>', :'iam_access_key' => :'String', :'iam_secret_key' => :'String', :'maximum_events' => :'Integer', :'maximum_size' => :'Integer', :'merchant_id' => :'String', :'next_retry_after' => :'String', :'pending' => :'Integer', :'webhook_oid' => :'Integer', :'webhook_url' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/ultracart_api/models/webhook.rb, line 262 def ==(o) return true if self.equal?(o) self.class == o.class && api_user_oid == o.api_user_oid && api_version == o.api_version && application_profile == o.application_profile && authentication_type == o.authentication_type && basic_password == o.basic_password && basic_username == o.basic_username && consecutive_failures == o.consecutive_failures && disabled == o.disabled && event_categories == o.event_categories && iam_access_key == o.iam_access_key && iam_secret_key == o.iam_secret_key && maximum_events == o.maximum_events && maximum_size == o.maximum_size && merchant_id == o.merchant_id && next_retry_after == o.next_retry_after && pending == o.pending && webhook_oid == o.webhook_oid && webhook_url == o.webhook_url end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/ultracart_api/models/webhook.rb, line 321 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :BOOLEAN if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model temp_model = UltracartClient.const_get(type).new temp_model.build_from_hash(value) end end
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/ultracart_api/models/webhook.rb, line 387 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end
Custom attribute writer method checking allowed values (enum). @param [Object] api_version
Object to be assigned
# File lib/ultracart_api/models/webhook.rb, line 242 def api_version=(api_version) validator = EnumAttributeValidator.new('String', ['2017-03-01']) unless validator.valid?(api_version) fail ArgumentError, 'invalid value for "api_version", must be one of #{validator.allowable_values}.' end @api_version = api_version end
Custom attribute writer method checking allowed values (enum). @param [Object] authentication_type
Object to be assigned
# File lib/ultracart_api/models/webhook.rb, line 252 def authentication_type=(authentication_type) validator = EnumAttributeValidator.new('String', ['none', 'basic']) unless validator.valid?(authentication_type) fail ArgumentError, 'invalid value for "authentication_type", must be one of #{validator.allowable_values}.' end @authentication_type = authentication_type end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/ultracart_api/models/webhook.rb, line 300 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end
@see the `==` method @param [Object] Object to be compared
# File lib/ultracart_api/models/webhook.rb, line 287 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/ultracart_api/models/webhook.rb, line 293 def hash [api_user_oid, api_version, application_profile, authentication_type, basic_password, basic_username, consecutive_failures, disabled, event_categories, iam_access_key, iam_secret_key, maximum_events, maximum_size, merchant_id, next_retry_after, pending, webhook_oid, webhook_url].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/ultracart_api/models/webhook.rb, line 225 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/ultracart_api/models/webhook.rb, line 373 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/ultracart_api/models/webhook.rb, line 361 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/ultracart_api/models/webhook.rb, line 232 def valid? api_version_validator = EnumAttributeValidator.new('String', ['2017-03-01']) return false unless api_version_validator.valid?(@api_version) authentication_type_validator = EnumAttributeValidator.new('String', ['none', 'basic']) return false unless authentication_type_validator.valid?(@authentication_type) true end