class Bfwd::TimeRequest
Request object for advancing a subscription's flow through time.
Attributes
{"default":true,"description":"When advancing onto an instant in time:
<span class=\"label label-default\">true</span> — Action the events scheduled for your destination time. Amendments scheduled at your destined time will be actioned during this time travel. Advancing to a period boundary will promote your subscription to the period on the future side of that boundary.
<span class=\"label label-default\">false</span> — Do not action events scheduled for your destination time. Amendments scheduled at your destined time will not be actioned during this time travel. Advancing to a period boundary will result in your subscription's remaining within the period on the past side of that boundary.","verbs":}
{ "description" : "The UTC DateTime when the object was created.", "verbs":[] }
{"default":false,"description":"Changes described in the response:
<span class=\"label label-default\">true</span> — Are not actually performed; your subscription remains unchanged, no billing events run, and no invoices are executed.
<span class=\"label label-default\">false</span> — Are actually performed and committed.","verbs":}
{"default":"<span class=\"label label-default\">SingleAttempt</span>","description":"What strategy to use when executing any invoices raised as time advances:
<span class=\"label label-default\">SingleAttempt</span> — Execute any invoice just once.
<span class=\"label label-default\">FollowDunning</span> — Apply the existing dunning strategy when executing invoices.
<span class=\"label label-default\">None</span>: Do not execute invoices.","verbs":}
{"default":false,"description":"Once the subscription is advanced through time:
<span class=\"label label-default\">true</span> — Freeze the subscription.
<span class=\"label label-default\">false</span> — Do not freeze the subscription.","verbs":}
{"default":true,"description":"As time scrubs forward:
<span class=\"label label-default\">true</span> — Run any amendments that were scheduled to action.
<span class=\"label label-default\">false</span> — Do not run any amendments that were scheduled to action.","verbs":}
{"description":"(Required: one of [`periods`, `to`])
The number of period boundaries up to which the subscription should advance. A 1-value advances the subscription to the end of its current service period. Higher values advance the subscription to subsequent period boundaries."verbs":}
{"default":false,"description":"As time scrubs forward:
<span class=\"label label-default\">true</span> — Raise no invoice upon advancing over a period boundary.
<span class=\"label label-default\">false</span> — Raise invoices for any period that is entered.","verbs":}
{"description":"(Required: one of [`periods`, `to`])
The time up until which the subscription should be fast-forwarded.","verbs":}
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/bf_ruby2/models/time_request.rb, line 68 def self.attribute_map { :'created' => :'created', :'periods' => :'periods', :'to' => :'to', :'dry_run' => :'dryRun', :'skip_intermediate_periods' => :'skipIntermediatePeriods', :'handle_amendments' => :'handleAmendments', :'execution_strategy' => :'executionStrategy', :'freeze_on_completion' => :'freezeOnCompletion', :'advance_inclusively' => :'advanceInclusively' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/bf_ruby2/models/time_request.rb, line 99 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?(:'created') self.created = attributes[:'created'] end if attributes.has_key?(:'periods') self.periods = attributes[:'periods'] end if attributes.has_key?(:'to') self.to = attributes[:'to'] end if attributes.has_key?(:'dryRun') self.dry_run = attributes[:'dryRun'] else self.dry_run = false end if attributes.has_key?(:'skipIntermediatePeriods') self.skip_intermediate_periods = attributes[:'skipIntermediatePeriods'] else self.skip_intermediate_periods = false end if attributes.has_key?(:'handleAmendments') self.handle_amendments = attributes[:'handleAmendments'] else self.handle_amendments = false end if attributes.has_key?(:'executionStrategy') self.execution_strategy = attributes[:'executionStrategy'] end if attributes.has_key?(:'freezeOnCompletion') self.freeze_on_completion = attributes[:'freezeOnCompletion'] else self.freeze_on_completion = false end if attributes.has_key?(:'advanceInclusively') self.advance_inclusively = attributes[:'advanceInclusively'] else self.advance_inclusively = false end end
Attribute type mapping.
# File lib/bf_ruby2/models/time_request.rb, line 83 def self.swagger_types { :'created' => :'DateTime', :'periods' => :'Integer', :'to' => :'DateTime', :'dry_run' => :'BOOLEAN', :'skip_intermediate_periods' => :'BOOLEAN', :'handle_amendments' => :'BOOLEAN', :'execution_strategy' => :'String', :'freeze_on_completion' => :'BOOLEAN', :'advance_inclusively' => :'BOOLEAN' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/bf_ruby2/models/time_request.rb, line 180 def ==(o) return true if self.equal?(o) self.class == o.class && created == o.created && periods == o.periods && to == o.to && dry_run == o.dry_run && skip_intermediate_periods == o.skip_intermediate_periods && handle_amendments == o.handle_amendments && execution_strategy == o.execution_strategy && freeze_on_completion == o.freeze_on_completion && advance_inclusively == o.advance_inclusively 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/bf_ruby2/models/time_request.rb, line 230 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 = Bfwd.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/bf_ruby2/models/time_request.rb, line 296 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/bf_ruby2/models/time_request.rb, line 209 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 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/bf_ruby2/models/time_request.rb, line 196 def eql?(o) self == o end
Custom attribute writer method checking allowed values (enum). @param [Object] execution_strategy
Object to be assigned
# File lib/bf_ruby2/models/time_request.rb, line 170 def execution_strategy=(execution_strategy) validator = EnumAttributeValidator.new('String', ["SingleAttempt", "FollowDunning", "None"]) unless validator.valid?(execution_strategy) fail ArgumentError, "invalid value for 'execution_strategy', must be one of #{validator.allowable_values}." end @execution_strategy = execution_strategy end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/bf_ruby2/models/time_request.rb, line 202 def hash [created, periods, to, dry_run, skip_intermediate_periods, handle_amendments, execution_strategy, freeze_on_completion, advance_inclusively].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/bf_ruby2/models/time_request.rb, line 155 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/bf_ruby2/models/time_request.rb, line 282 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/bf_ruby2/models/time_request.rb, line 270 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/bf_ruby2/models/time_request.rb, line 162 def valid? execution_strategy_validator = EnumAttributeValidator.new('String', ["SingleAttempt", "FollowDunning", "None"]) return false unless execution_strategy_validator.valid?(@execution_strategy) return true end