Class: UspsApi::TrackingResourceInfo

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

Overview

Information about the resource sending the information.

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(submission_type: SubmissionType::AUTOMATIC, submission_by: SubmissionBy::CUSTOMER, comments: SKIP, rating: SKIP, location_permission: SKIP, notification_permission: SKIP) ⇒ TrackingResourceInfo

Returns a new instance of TrackingResourceInfo.



65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/usps_api/models/tracking_resource_info.rb', line 65

def initialize(submission_type: SubmissionType::AUTOMATIC,
               submission_by: SubmissionBy::CUSTOMER, comments: SKIP,
               rating: SKIP, location_permission: SKIP,
               notification_permission: SKIP)
  @submission_type = submission_type unless submission_type == SKIP
  @submission_by = submission_by unless submission_by == SKIP
  @comments = comments unless comments == SKIP
  @rating = rating unless rating == SKIP
  @location_permission = location_permission unless location_permission == SKIP
  @notification_permission = notification_permission unless notification_permission == SKIP
end

Instance Attribute Details

#comments ⇒ String

Comments related to the submission.

Returns:

  • (String) 


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

def comments
  @comments
end

#location_permission ⇒ LocationPermission

Permission of location services status.

Returns:



30
31
32
 
# File 'lib/usps_api/models/tracking_resource_info.rb', line 30

def location_permission
  @location_permission
end

#notification_permission ⇒ NotificationPermission

Permission of notification services status.

Returns:



34
35
36
 
# File 'lib/usps_api/models/tracking_resource_info.rb', line 34

def notification_permission
  @notification_permission
end

#rating ⇒ Float

Rating (0-5).

Returns:

  • (Float) 


26
27
28
 
# File 'lib/usps_api/models/tracking_resource_info.rb', line 26

def rating
  @rating
end

#submission_by ⇒ SubmissionBy

Who submitted the information.

Returns:



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

def submission_by
  @submission_by
end

#submission_type ⇒ SubmissionType

Type of submission.

Returns:



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

def submission_type
  @submission_type
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/usps_api/models/tracking_resource_info.rb', line 78

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  submission_type = hash['submissionType'] ||= SubmissionType::AUTOMATIC
  submission_by = hash['submissionBy'] ||= SubmissionBy::CUSTOMER
  comments = hash.key?('comments') ? hash['comments'] : SKIP
  rating = hash.key?('rating') ? hash['rating'] : SKIP
  location_permission =
    hash.key?('locationPermission') ? hash['locationPermission'] : SKIP
  notification_permission =
    hash.key?('notificationPermission') ? hash['notificationPermission'] : SKIP

  # Create object from extracted values.
  TrackingResourceInfo.new(submission_type: submission_type,
                           submission_by: submission_by,
                           comments: comments,
                           rating: rating,
                           location_permission: location_permission,
                           notification_permission: notification_permission)
end

.names ⇒ Object

A mapping from model property names to API property names.



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/usps_api/models/tracking_resource_info.rb', line 37

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['submission_type'] = 'submissionType'
  @_hash['submission_by'] = 'submissionBy'
  @_hash['comments'] = 'comments'
  @_hash['rating'] = 'rating'
  @_hash['location_permission'] = 'locationPermission'
  @_hash['notification_permission'] = 'notificationPermission'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



61
62
63
 
# File 'lib/usps_api/models/tracking_resource_info.rb', line 61

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



49
50
51
52
53
54
55
56
57
58
 
# File 'lib/usps_api/models/tracking_resource_info.rb', line 49

def self.optionals
  %w[
    submission_type
    submission_by
    comments
    rating
    location_permission
    notification_permission
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



109
110
111
112
113
114
115
 
# File 'lib/usps_api/models/tracking_resource_info.rb', line 109

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} submission_type: #{@submission_type.inspect}, submission_by:"\
  " #{@submission_by.inspect}, comments: #{@comments.inspect}, rating: #{@rating.inspect},"\
  " location_permission: #{@location_permission.inspect}, notification_permission:"\
  " #{@notification_permission.inspect}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



101
102
103
104
105
106
 
# File 'lib/usps_api/models/tracking_resource_info.rb', line 101

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} submission_type: #{@submission_type}, submission_by: #{@submission_by},"\
  " comments: #{@comments}, rating: #{@rating}, location_permission: #{@location_permission},"\
  " notification_permission: #{@notification_permission}>"
end