Class: Bfwd::AuditEntry

Inherits:
Object
  • Object
show all
Defined in:
lib/bf_ruby2/models/audit_entry.rb

Overview

An entry from the audit-log, documenting the set of changes made to an entity during an insert or update.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AuditEntry

Initializes the object



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/bf_ruby2/models/audit_entry.rb', line 103

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?(:'changedBy')
    self.changed_by = attributes[:'changedBy']
  end

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'organizationID')
    self.organization_id = attributes[:'organizationID']
  end

  if attributes.has_key?(:'entity')
    self.entity = attributes[:'entity']
  end

  if attributes.has_key?(:'entityID')
    self.entity_id = attributes[:'entityID']
  end

  if attributes.has_key?(:'auditAction')
    self.audit_action = attributes[:'auditAction']
  end

  if attributes.has_key?(:'fieldChanges')
    if (value = attributes[:'fieldChanges']).is_a?(Array)
      self.field_changes = value
    end
  end

  if attributes.has_key?(:'newEntity')
    if (value = attributes[:'newEntity']).is_a?(Array)
      self.new_entity = value
    end
  end

  if attributes.has_key?(:'state')
    self.state = attributes[:'state']
  end

  if attributes.has_key?(:'created')
    self.created = attributes[:'created']
  end

end

Instance Attribute Details

#audit_action ⇒ Object

{ "description" : "update, insert", "verbs“: }



34
35
36
 
# File 'lib/bf_ruby2/models/audit_entry.rb', line 34

def audit_action
  @audit_action
end

#changed_by ⇒ Object

{ "description" : "ID of the user who made the change.", "verbs“: }



19
20
21
 
# File 'lib/bf_ruby2/models/audit_entry.rb', line 19

def changed_by
  @changed_by
end

#created ⇒ Object

{ "description" : "The UTC DateTime when the object was created.", "verbs":[] }



45
46
47
 
# File 'lib/bf_ruby2/models/audit_entry.rb', line 45

def created
  @created
end

#entity ⇒ Object

{ "description" : "The entity type.", "verbs“: }



28
29
30
 
# File 'lib/bf_ruby2/models/audit_entry.rb', line 28

def entity
  @entity
end

#entity_id ⇒ Object

{ "description" : "ID of the entity.", "verbs“: }



31
32
33
 
# File 'lib/bf_ruby2/models/audit_entry.rb', line 31

def entity_id
  @entity_id
end

#field_changes ⇒ Object

{ "description" : "A description of the changes.", "verbs“: }



37
38
39
 
# File 'lib/bf_ruby2/models/audit_entry.rb', line 37

def field_changes
  @field_changes
end

#id ⇒ Object

{ "description" : "ID of the audit-entry.", "verbs“: }



22
23
24
 
# File 'lib/bf_ruby2/models/audit_entry.rb', line 22

def id
  @id
end

#new_entity ⇒ Object

Returns the value of attribute new_entity.



39
40
41
 
# File 'lib/bf_ruby2/models/audit_entry.rb', line 39

def new_entity
  @new_entity
end

#organization_id ⇒ Object

{ "description" : "ID of the organization associated with the audit-entry.", "verbs“: }



25
26
27
 
# File 'lib/bf_ruby2/models/audit_entry.rb', line 25

def organization_id
  @organization_id
end

#state ⇒ Object

{ "description" : "The state of the audit entry.", "verbs“: }



42
43
44
 
# File 'lib/bf_ruby2/models/audit_entry.rb', line 42

def state
  @state
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/bf_ruby2/models/audit_entry.rb', line 70

def self.attribute_map
  {
    :'changed_by' => :'changedBy',
    :'id' => :'id',
    :'organization_id' => :'organizationID',
    :'entity' => :'entity',
    :'entity_id' => :'entityID',
    :'audit_action' => :'auditAction',
    :'field_changes' => :'fieldChanges',
    :'new_entity' => :'newEntity',
    :'state' => :'state',
    :'created' => :'created'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/bf_ruby2/models/audit_entry.rb', line 86

def self.swagger_types
  {
    :'changed_by' => :'String',
    :'id' => :'String',
    :'organization_id' => :'String',
    :'entity' => :'String',
    :'entity_id' => :'String',
    :'audit_action' => :'String',
    :'field_changes' => :'Array<String>',
    :'new_entity' => :'Array<String>',
    :'state' => :'String',
    :'created' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/bf_ruby2/models/audit_entry.rb', line 251

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      changed_by == o.changed_by &&
      id == o.id &&
      organization_id == o.organization_id &&
      entity == o.entity &&
      entity_id == o.entity_id &&
      audit_action == o.audit_action &&
      field_changes == o.field_changes &&
      new_entity == o.new_entity &&
      state == o.state &&
      created == o.created
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/bf_ruby2/models/audit_entry.rb', line 302

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

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/bf_ruby2/models/audit_entry.rb', line 368

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

#build_from_hash(attributes) ⇒ Object

Builds the object from hash



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/bf_ruby2/models/audit_entry.rb', line 281

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

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


268
269
270
 
# File 'lib/bf_ruby2/models/audit_entry.rb', line 268

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



274
275
276
 
# File 'lib/bf_ruby2/models/audit_entry.rb', line 274

def hash
  [changed_by, id, organization_id, entity, entity_id, audit_action, field_changes, new_entity, state, created].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/bf_ruby2/models/audit_entry.rb', line 157

def list_invalid_properties
  invalid_properties = Array.new
  if @changed_by.nil?
    invalid_properties.push("invalid value for 'changed_by', changed_by cannot be nil.")
  end

  if @id.nil?
    invalid_properties.push("invalid value for 'id', id cannot be nil.")
  end

  if @organization_id.nil?
    invalid_properties.push("invalid value for 'organization_id', organization_id cannot be nil.")
  end

  if @entity.nil?
    invalid_properties.push("invalid value for 'entity', entity cannot be nil.")
  end

  if @entity_id.nil?
    invalid_properties.push("invalid value for 'entity_id', entity_id cannot be nil.")
  end

  if @audit_action.nil?
    invalid_properties.push("invalid value for 'audit_action', audit_action cannot be nil.")
  end

  if @field_changes.nil?
    invalid_properties.push("invalid value for 'field_changes', field_changes cannot be nil.")
  end

  if @new_entity.nil?
    invalid_properties.push("invalid value for 'new_entity', new_entity cannot be nil.")
  end

  if @state.nil?
    invalid_properties.push("invalid value for 'state', state cannot be nil.")
  end

  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



348
349
350
 
# File 'lib/bf_ruby2/models/audit_entry.rb', line 348

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



354
355
356
357
358
359
360
361
362
 
# File 'lib/bf_ruby2/models/audit_entry.rb', line 354

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

#to_s ⇒ String

Returns the string representation of the object



342
343
344
 
# File 'lib/bf_ruby2/models/audit_entry.rb', line 342

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/bf_ruby2/models/audit_entry.rb', line 200

def valid?
  return false if @changed_by.nil?
  return false if @id.nil?
  return false if @organization_id.nil?
  return false if @entity.nil?
  entity_validator = EnumAttributeValidator.new('String', ["Notification", "Organization", "OrganizationGateway", "Product", "User", "Subscription", "Profile", "ProductRatePlan", "Client", "Invoice", "PricingComponentValue", "Account", "PricingComponentValueChange", "PricingComponentTier", "PricingComponent", "PricingCalculation", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "CouponBookDefinition", "CouponBook", "InvoiceLine", "Webhook", "SubscriptionCancellation", "NotificationSnapshot", "InvoicePayment", "InvoiceLinePayment", "Payment", "PaymentMethod", "PaymentMethodSubscriptionLink", "DunningLine", "CybersourceToken", "Card", "Alias", "PaypalSimplePaymentReconciliation", "FreePaymentReconciliation", "LocustworldPaymentReconciliation", "CouponInstanceExistingValue", "TaxLine", "TaxationStrategy", "TaxationLink", "Address", "AmendmentPriceNTime", "Authority", "UnitOfMeasure", "SearchResult", "Amendment", "AuditLog", "Password", "Username", "FixedTermDefinition", "FixedTerm", "Refund", "CreditNote", "Receipt", "AmendmentCompoundConstituent", "APIConfiguration", "StripeToken", "BraintreeToken", "BalancedToken", "PaypalToken", "AuthorizeNetToken", "SpreedlyToken", "GatewayRevenue", "AmendmentDiscardAmendment", "CancellationAmendment", "CompoundAmendment", "CompoundAmendmentConstituent", "FixedTermExpiryAmendment", "InvoiceNextExecutionAttemptAmendment", "PricingComponentValueAmendment", "BraintreeMerchantAccount", "WebhookSubscription", "Migration", "CassResult", "CassPaymentResult", "CassProductRatePlanResult", "CassChurnResult", "CassUpgradeResult", "SubscriptionCharge", "CassPaymentPProductResult", "ProductPaymentsArgs", "StripeACHToken", "UsageAmount", "UsageSession", "Usage", "UsagePeriod", "Period", "OfflinePayment", "CreditNotePayment", "CardVaultPayment", "FreePayment", "BraintreePayment", "BalancedPayment", "CybersourcePayment", "PaypalPayment", "PaypalSimplePayment", "LocustWorldPayment", "StripeOnlyPayment", "ProductPaymentsResult", "StripeACHPayment", "AuthorizeNetPayment", "CompoundUsageSession", "CompoundUsage", "UsageRoundingStrategies", "BillforwardManagedPaymentsResult", "PricingComponentValueMigrationChargeAmendmentMapping", "SubscriptionLTVResult", "AccountLTVResult", "ProductRatePlanPaymentsResult", "DebtsResult", "AccountPaymentsResult", "ComponentChange", "QuoteRequest", "Quote", "CouponCharge", "CouponInstanceInvoiceLink", "Coupon", "CouponDiscount", "CouponUniqueCodesRequest", "CouponUniqueCodesResponse", "GetCouponsResponse", "AddCouponCodeRequest", "AddCouponCodeResponse", "RemoveCouponFromSubscriptionRequest", "TokenizationPreAuth", "StripeTokenizationPreAuth", "BraintreeTokenizationPreAuth", "SpreedlyTokenizationPreAuth", "SagePayTokenizationPreAuth", "PayVisionTokenizationPreAuth", "TokenizationPreAuthRequest", "AuthCaptureRequest", "StripeACHBankAccountVerification", "PasswordReset", "PricingRequest", "AddTaxationStrategyRequest", "AddPaymentMethodRequest", "APIRequest", "SagePayToken", "SagePayNotificationRequest", "SagePayNotificationResponse", "SagePayOutstandingTransaction", "SagePayEnabledCardType", "TrustCommerceToken", "SagePayTransaction", "PricingComponentValueResponse", "MigrationResponse", "TimeResponse", "EntityTime", "Email", "AggregationLink", "BFPermission", "Role", "PermissionLink", "PayVisionToken", "PayVisionTransaction", "KashToken", "EmailProvider", "DataSynchronizationJob", "DataSynchronizationJobError", "DataSynchronizationConfiguration", "DataSynchronizationAppConfiguration", "AggregationChildrenResponse", "MetadataKeyValue", "Metadata", "AggregatingComponent", "PricingComponentMigrationValue", "InvoiceRecalculationAmendment", "IssueInvoiceAmendment", "EmailSubscription", "RevenueAttribution"])
  return false unless entity_validator.valid?(@entity)
  return false if @entity_id.nil?
  return false if @audit_action.nil?
  audit_action_validator = EnumAttributeValidator.new('String', ["Accept", "Active", "AwaitingPayment", "AwaitingRefund", "Cancelled", "Completed", "Created", "Error", "Expiring", "Expired", "Failed", "Migrated", "NeedsAmendments", "Paid", "Pending", "Provisioned", "Refunded", "Reject", "Trial", "Unknown", "Unpaid", "Updated", "Voided", "PaymentFailed"])
  return false unless audit_action_validator.valid?(@audit_action)
  return false if @field_changes.nil?
  return false if @new_entity.nil?
  return false if @state.nil?
  state_validator = EnumAttributeValidator.new('String', ["New", "Processed"])
  return false unless state_validator.valid?(@state)
  return true
end