Class: UspsApi::DisputeDetails

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

Overview

DisputeDetails 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(request_type: SKIP, request_status: SKIP, crid: SKIP, manifest_package_id: SKIP, eps_account_number: SKIP, mail_class: SKIP, mailer_id: SKIP, original_dispute_amount: SKIP, transaction_amount: SKIP, dispute_id: SKIP, dispute_closeout_id: SKIP, dispute_reason: SKIP, resolution_status: SKIP, resolution_date: SKIP, additional_properties: nil) ⇒ DisputeDetails

Returns a new instance of DisputeDetails.



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
 
# File 'lib/usps_api/models/dispute_details.rb', line 114

def initialize(request_type: SKIP, request_status: SKIP, crid: SKIP,
               manifest_package_id: SKIP, eps_account_number: SKIP,
               mail_class: SKIP, mailer_id: SKIP,
               original_dispute_amount: SKIP, transaction_amount: SKIP,
               dispute_id: SKIP, dispute_closeout_id: SKIP,
               dispute_reason: SKIP, resolution_status: SKIP,
               resolution_date: SKIP, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @request_type = request_type unless request_type == SKIP
  @request_status = request_status unless request_status == SKIP
  @crid = crid unless crid == SKIP
  @manifest_package_id = manifest_package_id unless manifest_package_id == SKIP
  @eps_account_number =  unless  == SKIP
  @mail_class = mail_class unless mail_class == SKIP
  @mailer_id = mailer_id unless mailer_id == SKIP
  @original_dispute_amount = original_dispute_amount unless original_dispute_amount == SKIP
  @transaction_amount = transaction_amount unless transaction_amount == SKIP
  @dispute_id = dispute_id unless dispute_id == SKIP
  @dispute_closeout_id = dispute_closeout_id unless dispute_closeout_id == SKIP
  @dispute_reason = dispute_reason unless dispute_reason == SKIP
  @resolution_status = resolution_status unless resolution_status == SKIP
  @resolution_date = resolution_date unless resolution_date == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#crid ⇒ String

Customer Registration Identifier

Returns:

  • (String) 


23
24
25
 
# File 'lib/usps_api/models/dispute_details.rb', line 23

def crid
  @crid
end

#dispute_closeout_id ⇒ String

Dispute closeout Id

Returns:

  • (String) 


55
56
57
 
# File 'lib/usps_api/models/dispute_details.rb', line 55

def dispute_closeout_id
  @dispute_closeout_id
end

#dispute_id ⇒ String

Dispute Id

Returns:

  • (String) 


51
52
53
 
# File 'lib/usps_api/models/dispute_details.rb', line 51

def dispute_id
  @dispute_id
end

#dispute_reason ⇒ String

Dispute Reason

Returns:

  • (String) 


59
60
61
 
# File 'lib/usps_api/models/dispute_details.rb', line 59

def dispute_reason
  @dispute_reason
end

#eps_account_number ⇒ String

EPS account Number.

Returns:

  • (String) 


31
32
33
 
# File 'lib/usps_api/models/dispute_details.rb', line 31

def 
  @eps_account_number
end

#mail_class ⇒ String

Mail Class.

Returns:

  • (String) 


35
36
37
 
# File 'lib/usps_api/models/dispute_details.rb', line 35

def mail_class
  @mail_class
end

#mailer_id ⇒ String

Mailer ID.

Returns:

  • (String) 


39
40
41
 
# File 'lib/usps_api/models/dispute_details.rb', line 39

def mailer_id
  @mailer_id
end

#manifest_package_id ⇒ String

The manifest package Id.

Returns:

  • (String) 


27
28
29
 
# File 'lib/usps_api/models/dispute_details.rb', line 27

def manifest_package_id
  @manifest_package_id
end

#original_dispute_amount ⇒ Float

Original dispute amount

Returns:

  • (Float) 


43
44
45
 
# File 'lib/usps_api/models/dispute_details.rb', line 43

def original_dispute_amount
  @original_dispute_amount
end

#request_status ⇒ RequestStatus

Current status of the Request.

Returns:



19
20
21
 
# File 'lib/usps_api/models/dispute_details.rb', line 19

def request_status
  @request_status
end

#request_type ⇒ RequestType

TODO: Write general description for this method

Returns:



15
16
17
 
# File 'lib/usps_api/models/dispute_details.rb', line 15

def request_type
  @request_type
end

#resolution_date ⇒ DateTime

resolution date time.

Returns:

  • (DateTime) 


67
68
69
 
# File 'lib/usps_api/models/dispute_details.rb', line 67

def resolution_date
  @resolution_date
end

#resolution_status ⇒ String

Resolution Status

Returns:

  • (String) 


63
64
65
 
# File 'lib/usps_api/models/dispute_details.rb', line 63

def resolution_status
  @resolution_status
end

#transaction_amount ⇒ Float

Transaction amount

Returns:

  • (Float) 


47
48
49
 
# File 'lib/usps_api/models/dispute_details.rb', line 47

def transaction_amount
  @transaction_amount
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
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
 
# File 'lib/usps_api/models/dispute_details.rb', line 142

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  request_type = hash.key?('requestType') ? hash['requestType'] : SKIP
  request_status = hash.key?('requestStatus') ? hash['requestStatus'] : SKIP
  crid = hash.key?('CRID') ? hash['CRID'] : SKIP
  manifest_package_id =
    hash.key?('manifestPackageID') ? hash['manifestPackageID'] : SKIP
   =
    hash.key?('EPSAccountNumber') ? hash['EPSAccountNumber'] : SKIP
  mail_class = hash.key?('mailClass') ? hash['mailClass'] : SKIP
  mailer_id = hash.key?('mailerID') ? hash['mailerID'] : SKIP
  original_dispute_amount =
    hash.key?('originalDisputeAmount') ? hash['originalDisputeAmount'] : SKIP
  transaction_amount =
    hash.key?('transactionAmount') ? hash['transactionAmount'] : SKIP
  dispute_id = hash.key?('disputeID') ? hash['disputeID'] : SKIP
  dispute_closeout_id =
    hash.key?('disputeCloseoutID') ? hash['disputeCloseoutID'] : SKIP
  dispute_reason = hash.key?('disputeReason') ? hash['disputeReason'] : SKIP
  resolution_status =
    hash.key?('resolutionStatus') ? hash['resolutionStatus'] : SKIP
  resolution_date = if hash.key?('resolutionDate')
                      (DateTimeHelper.from_rfc3339(hash['resolutionDate']) if hash['resolutionDate'])
                    else
                      SKIP
                    end

  # 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.
  DisputeDetails.new(request_type: request_type,
                     request_status: request_status,
                     crid: crid,
                     manifest_package_id: manifest_package_id,
                     eps_account_number: ,
                     mail_class: mail_class,
                     mailer_id: mailer_id,
                     original_dispute_amount: original_dispute_amount,
                     transaction_amount: transaction_amount,
                     dispute_id: dispute_id,
                     dispute_closeout_id: dispute_closeout_id,
                     dispute_reason: dispute_reason,
                     resolution_status: resolution_status,
                     resolution_date: resolution_date,
                     additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/usps_api/models/dispute_details.rb', line 70

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['request_type'] = 'requestType'
  @_hash['request_status'] = 'requestStatus'
  @_hash['crid'] = 'CRID'
  @_hash['manifest_package_id'] = 'manifestPackageID'
  @_hash['eps_account_number'] = 'EPSAccountNumber'
  @_hash['mail_class'] = 'mailClass'
  @_hash['mailer_id'] = 'mailerID'
  @_hash['original_dispute_amount'] = 'originalDisputeAmount'
  @_hash['transaction_amount'] = 'transactionAmount'
  @_hash['dispute_id'] = 'disputeID'
  @_hash['dispute_closeout_id'] = 'disputeCloseoutID'
  @_hash['dispute_reason'] = 'disputeReason'
  @_hash['resolution_status'] = 'resolutionStatus'
  @_hash['resolution_date'] = 'resolutionDate'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



110
111
112
 
# File 'lib/usps_api/models/dispute_details.rb', line 110

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/usps_api/models/dispute_details.rb', line 90

def self.optionals
  %w[
    request_type
    request_status
    crid
    manifest_package_id
    eps_account_number
    mail_class
    mailer_id
    original_dispute_amount
    transaction_amount
    dispute_id
    dispute_closeout_id
    dispute_reason
    resolution_status
    resolution_date
  ]
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:

  • The (DisputeDetails | Hash) —

    value against the validation is performed.



202
203
204
205
206
207
208
 
# File 'lib/usps_api/models/dispute_details.rb', line 202

def self.validate(value)
  return true if value.instance_of? self

  return false unless value.instance_of? Hash

  true
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/usps_api/models/dispute_details.rb', line 224

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} request_type: #{@request_type.inspect}, request_status:"\
  " #{@request_status.inspect}, crid: #{@crid.inspect}, manifest_package_id:"\
  " #{@manifest_package_id.inspect}, eps_account_number: #{@eps_account_number.inspect},"\
  " mail_class: #{@mail_class.inspect}, mailer_id: #{@mailer_id.inspect},"\
  " original_dispute_amount: #{@original_dispute_amount.inspect}, transaction_amount:"\
  " #{@transaction_amount.inspect}, dispute_id: #{@dispute_id.inspect}, dispute_closeout_id:"\
  " #{@dispute_closeout_id.inspect}, dispute_reason: #{@dispute_reason.inspect},"\
  " resolution_status: #{@resolution_status.inspect}, resolution_date:"\
  " #{@resolution_date.inspect}, additional_properties: #{@additional_properties}>"
end

#to_custom_resolution_date ⇒ Object 



196
197
198
 
# File 'lib/usps_api/models/dispute_details.rb', line 196

def to_custom_resolution_date
  DateTimeHelper.to_rfc3339(resolution_date)
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/usps_api/models/dispute_details.rb', line 211

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} request_type: #{@request_type}, request_status: #{@request_status}, crid:"\
  " #{@crid}, manifest_package_id: #{@manifest_package_id}, eps_account_number:"\
  " #{@eps_account_number}, mail_class: #{@mail_class}, mailer_id: #{@mailer_id},"\
  " original_dispute_amount: #{@original_dispute_amount}, transaction_amount:"\
  " #{@transaction_amount}, dispute_id: #{@dispute_id}, dispute_closeout_id:"\
  " #{@dispute_closeout_id}, dispute_reason: #{@dispute_reason}, resolution_status:"\
  " #{@resolution_status}, resolution_date: #{@resolution_date}, additional_properties:"\
  " #{@additional_properties}>"
end