Class: PaypalServerSdk::AuctionInformation

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/paypal_server_sdk/models/auction_information.rb

Overview

The auction 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(auction_site: SKIP, auction_item_site: SKIP, auction_buyer_id: SKIP, auction_closing_date: SKIP) ⇒ AuctionInformation

Returns a new instance of AuctionInformation.



57
58
59
60
61
62
63
 
# File 'lib/paypal_server_sdk/models/auction_information.rb', line 57

def initialize(auction_site: SKIP, auction_item_site: SKIP,
               auction_buyer_id: SKIP, auction_closing_date: SKIP)
  @auction_site = auction_site unless auction_site == SKIP
  @auction_item_site = auction_item_site unless auction_item_site == SKIP
  @auction_buyer_id = auction_buyer_id unless auction_buyer_id == SKIP
  @auction_closing_date = auction_closing_date unless auction_closing_date == SKIP
end

Instance Attribute Details

#auction_buyer_id ⇒ String

The ID of the buyer who makes the purchase in the auction. This ID might be different from the payer ID provided for the payment.

Returns:

  • (String) 


23
24
25
 
# File 'lib/paypal_server_sdk/models/auction_information.rb', line 23

def auction_buyer_id
  @auction_buyer_id
end

#auction_closing_date ⇒ String

The date and time, in [Internet date and time format](tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates.

Returns:

  • (String) 


30
31
32
 
# File 'lib/paypal_server_sdk/models/auction_information.rb', line 30

def auction_closing_date
  @auction_closing_date
end

#auction_item_site ⇒ String

The auction site URL.

Returns:

  • (String) 


18
19
20
 
# File 'lib/paypal_server_sdk/models/auction_information.rb', line 18

def auction_item_site
  @auction_item_site
end

#auction_site ⇒ String

The name of the auction site.

Returns:

  • (String) 


14
15
16
 
# File 'lib/paypal_server_sdk/models/auction_information.rb', line 14

def auction_site
  @auction_site
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
 
# File 'lib/paypal_server_sdk/models/auction_information.rb', line 66

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  auction_site = hash.key?('auction_site') ? hash['auction_site'] : SKIP
  auction_item_site =
    hash.key?('auction_item_site') ? hash['auction_item_site'] : SKIP
  auction_buyer_id =
    hash.key?('auction_buyer_id') ? hash['auction_buyer_id'] : SKIP
  auction_closing_date =
    hash.key?('auction_closing_date') ? hash['auction_closing_date'] : SKIP

  # Create object from extracted values.
  AuctionInformation.new(auction_site: auction_site,
                         auction_item_site: auction_item_site,
                         auction_buyer_id: auction_buyer_id,
                         auction_closing_date: auction_closing_date)
end

.names ⇒ Object

A mapping from model property names to API property names.



33
34
35
36
37
38
39
40
 
# File 'lib/paypal_server_sdk/models/auction_information.rb', line 33

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['auction_site'] = 'auction_site'
  @_hash['auction_item_site'] = 'auction_item_site'
  @_hash['auction_buyer_id'] = 'auction_buyer_id'
  @_hash['auction_closing_date'] = 'auction_closing_date'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



53
54
55
 
# File 'lib/paypal_server_sdk/models/auction_information.rb', line 53

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



43
44
45
46
47
48
49
50
 
# File 'lib/paypal_server_sdk/models/auction_information.rb', line 43

def self.optionals
  %w[
    auction_site
    auction_item_site
    auction_buyer_id
    auction_closing_date
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



93
94
95
96
97
98
 
# File 'lib/paypal_server_sdk/models/auction_information.rb', line 93

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} auction_site: #{@auction_site.inspect}, auction_item_site:"\
  " #{@auction_item_site.inspect}, auction_buyer_id: #{@auction_buyer_id.inspect},"\
  " auction_closing_date: #{@auction_closing_date.inspect}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



86
87
88
89
90
 
# File 'lib/paypal_server_sdk/models/auction_information.rb', line 86

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} auction_site: #{@auction_site}, auction_item_site: #{@auction_item_site},"\
  " auction_buyer_id: #{@auction_buyer_id}, auction_closing_date: #{@auction_closing_date}>"
end