Class: UspsApi::DisputeValidationRequest

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/usps_api/models/dispute_validation_request.rb

Overview

DisputeValidationRequest Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(eps_transaction_id:, tracking_id:, crid: SKIP, additional_properties: nil) ⇒ DisputeValidationRequest

Returns a new instance of DisputeValidationRequest.



45
46
47
48
49
50
51
52
53
54
 
# File 'lib/usps_api/models/dispute_validation_request.rb', line 45

def initialize(eps_transaction_id:, tracking_id:, crid: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @eps_transaction_id = eps_transaction_id
  @tracking_id = tracking_id
  @crid = crid unless crid == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#crid ⇒ String

Customer Registration ID (CRID) of the mail owner.

Returns:

  • (String) 


22
23
24
 
# File 'lib/usps_api/models/dispute_validation_request.rb', line 22

def crid
  @crid
end

#eps_transaction_id ⇒ String

EPS Transaction ID for the Census charge.

Returns:

  • (String) 


14
15
16
 
# File 'lib/usps_api/models/dispute_validation_request.rb', line 14

def eps_transaction_id
  @eps_transaction_id
end

#tracking_id ⇒ String

IMpb barcode for the package.

Returns:

  • (String) 


18
19
20
 
# File 'lib/usps_api/models/dispute_validation_request.rb', line 18

def tracking_id
  @tracking_id
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/usps_api/models/dispute_validation_request.rb', line 57

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  eps_transaction_id =
    hash.key?('EPSTransactionID') ? hash['EPSTransactionID'] : nil
  tracking_id = hash.key?('trackingID') ? hash['trackingID'] : nil
  crid = hash.key?('CRID') ? hash['CRID'] : SKIP

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  DisputeValidationRequest.new(eps_transaction_id: eps_transaction_id,
                               tracking_id: tracking_id,
                               crid: crid,
                               additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



25
26
27
28
29
30
31
 
# File 'lib/usps_api/models/dispute_validation_request.rb', line 25

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['eps_transaction_id'] = 'EPSTransactionID'
  @_hash['tracking_id'] = 'trackingID'
  @_hash['crid'] = 'CRID'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



41
42
43
 
# File 'lib/usps_api/models/dispute_validation_request.rb', line 41

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



34
35
36
37
38
 
# File 'lib/usps_api/models/dispute_validation_request.rb', line 34

def self.optionals
  %w[
    crid
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



88
89
90
91
92
93
 
# File 'lib/usps_api/models/dispute_validation_request.rb', line 88

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} eps_transaction_id: #{@eps_transaction_id.inspect}, tracking_id:"\
  " #{@tracking_id.inspect}, crid: #{@crid.inspect}, additional_properties:"\
  " #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



81
82
83
84
85
 
# File 'lib/usps_api/models/dispute_validation_request.rb', line 81

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} eps_transaction_id: #{@eps_transaction_id}, tracking_id: #{@tracking_id},"\
  " crid: #{@crid}, additional_properties: #{@additional_properties}>"
end