Class: PaypalServerSdk::CancelSubscriptionRequest

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

Overview

The cancel subscription request details.

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(reason:) ⇒ CancelSubscriptionRequest

Returns a new instance of CancelSubscriptionRequest.



33
34
35
 
# File 'lib/paypal_server_sdk/models/cancel_subscription_request.rb', line 33

def initialize(reason:)
  @reason = reason
end

Instance Attribute Details

#reason ⇒ String

The reason for the cancellation of a subscription.

Returns:

  • (String) 


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

def reason
  @reason
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



38
39
40
41
42
43
44
45
46
 
# File 'lib/paypal_server_sdk/models/cancel_subscription_request.rb', line 38

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  reason = hash.key?('reason') ? hash['reason'] : nil

  # Create object from extracted values.
  CancelSubscriptionRequest.new(reason: reason)
end

.names ⇒ Object

A mapping from model property names to API property names.



17
18
19
20
21
 
# File 'lib/paypal_server_sdk/models/cancel_subscription_request.rb', line 17

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

.nullables ⇒ Object

An array for nullable fields



29
30
31
 
# File 'lib/paypal_server_sdk/models/cancel_subscription_request.rb', line 29

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



24
25
26
 
# File 'lib/paypal_server_sdk/models/cancel_subscription_request.rb', line 24

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



55
56
57
58
 
# File 'lib/paypal_server_sdk/models/cancel_subscription_request.rb', line 55

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



49
50
51
52
 
# File 'lib/paypal_server_sdk/models/cancel_subscription_request.rb', line 49

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