Class: PaypalServerSdk::SubscriptionCollection

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

Overview

The list of subscriptions.

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(subscriptions: SKIP, links: SKIP) ⇒ SubscriptionCollection

Returns a new instance of SubscriptionCollection.



42
43
44
45
 
# File 'lib/paypal_server_sdk/models/subscription_collection.rb', line 42

def initialize(subscriptions: SKIP, links: SKIP)
  @subscriptions = subscriptions unless subscriptions == SKIP
  @links = links unless links == SKIP
end

Instance Attribute Details

An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links).

Returns:



19
20
21
 
# File 'lib/paypal_server_sdk/models/subscription_collection.rb', line 19

def links
  @links
end

#subscriptions ⇒ Array[Subscription]

An array of subscriptions.

Returns:



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

def subscriptions
  @subscriptions
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/paypal_server_sdk/models/subscription_collection.rb', line 48

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  # Parameter is an array, so we need to iterate through it

  subscriptions = nil
  unless hash['subscriptions'].nil?
    subscriptions = []
    hash['subscriptions'].each do |structure|
      subscriptions << (Subscription.from_hash(structure) if structure)
    end
  end

  subscriptions = SKIP unless hash.key?('subscriptions')
  # Parameter is an array, so we need to iterate through it

  links = nil
  unless hash['links'].nil?
    links = []
    hash['links'].each do |structure|
      links << (LinkDescription.from_hash(structure) if structure)
    end
  end

  links = SKIP unless hash.key?('links')

  # Create object from extracted values.

  SubscriptionCollection.new(subscriptions: subscriptions,
                             links: links)
end

.names ⇒ Object

A mapping from model property names to API property names.



22
23
24
25
26
27
 
# File 'lib/paypal_server_sdk/models/subscription_collection.rb', line 22

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['subscriptions'] = 'subscriptions'
  @_hash['links'] = 'links'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



38
39
40
 
# File 'lib/paypal_server_sdk/models/subscription_collection.rb', line 38

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



30
31
32
33
34
35
 
# File 'lib/paypal_server_sdk/models/subscription_collection.rb', line 30

def self.optionals
  %w[
    subscriptions
    links
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



85
86
87
88
 
# File 'lib/paypal_server_sdk/models/subscription_collection.rb', line 85

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} subscriptions: #{@subscriptions.inspect}, links: #{@links.inspect}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



79
80
81
82
 
# File 'lib/paypal_server_sdk/models/subscription_collection.rb', line 79

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} subscriptions: #{@subscriptions}, links: #{@links}>"
end