Class: FdxV660Api::AvailabilityEntity

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/fdx_v660_api/models/availability_entity.rb

Overview

Response object for /availability API

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(status: SKIP, description: SKIP, operation_id: SKIP, planned_availability: SKIP, additional_properties: nil) ⇒ AvailabilityEntity

Returns a new instance of AvailabilityEntity.



53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/fdx_v660_api/models/availability_entity.rb', line 53

def initialize(status: SKIP, description: SKIP, operation_id: SKIP,
               planned_availability: SKIP, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @status = status unless status == SKIP
  @description = description unless description == SKIP
  @operation_id = operation_id unless operation_id == SKIP
  @planned_availability = planned_availability unless planned_availability == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#description ⇒ String

Description of availability status

Returns:

  • (String) 


18
19
20
 
# File 'lib/fdx_v660_api/models/availability_entity.rb', line 18

def description
  @description
end

#operation_id ⇒ FdxResourceOperationId3

Operation ID (e.g. name) for this Availability

Returns:



22
23
24
 
# File 'lib/fdx_v660_api/models/availability_entity.rb', line 22

def operation_id
  @operation_id
end

#planned_availability ⇒ Array[PlannedAvailabilityEntity]

Provider's plan for API availability

Returns:



26
27
28
 
# File 'lib/fdx_v660_api/models/availability_entity.rb', line 26

def planned_availability
  @planned_availability
end

#status ⇒ AvailabilityStatus3

Status of API availability

Returns:



14
15
16
 
# File 'lib/fdx_v660_api/models/availability_entity.rb', line 14

def status
  @status
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/fdx_v660_api/models/availability_entity.rb', line 66

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  status = hash.key?('status') ? hash['status'] : SKIP
  description = hash.key?('description') ? hash['description'] : SKIP
  operation_id = hash.key?('operationId') ? hash['operationId'] : SKIP
  # Parameter is an array, so we need to iterate through it
  planned_availability = nil
  unless hash['plannedAvailability'].nil?
    planned_availability = []
    hash['plannedAvailability'].each do |structure|
      planned_availability << (PlannedAvailabilityEntity.from_hash(structure) if structure)
    end
  end

  planned_availability = SKIP unless hash.key?('plannedAvailability')

  # 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.
  AvailabilityEntity.new(status: status,
                         description: description,
                         operation_id: operation_id,
                         planned_availability: planned_availability,
                         additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



29
30
31
32
33
34
35
36
 
# File 'lib/fdx_v660_api/models/availability_entity.rb', line 29

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['status'] = 'status'
  @_hash['description'] = 'description'
  @_hash['operation_id'] = 'operationId'
  @_hash['planned_availability'] = 'plannedAvailability'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



49
50
51
 
# File 'lib/fdx_v660_api/models/availability_entity.rb', line 49

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



39
40
41
42
43
44
45
46
 
# File 'lib/fdx_v660_api/models/availability_entity.rb', line 39

def self.optionals
  %w[
    status
    description
    operation_id
    planned_availability
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



108
109
110
111
112
113
 
# File 'lib/fdx_v660_api/models/availability_entity.rb', line 108

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} status: #{@status.inspect}, description: #{@description.inspect},"\
  " operation_id: #{@operation_id.inspect}, planned_availability:"\
  " #{@planned_availability.inspect}, additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



100
101
102
103
104
105
 
# File 'lib/fdx_v660_api/models/availability_entity.rb', line 100

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} status: #{@status}, description: #{@description}, operation_id:"\
  " #{@operation_id}, planned_availability: #{@planned_availability}, additional_properties:"\
  " #{@additional_properties}>"
end