Class: PaypalServerSdk::CaptureSubscriptionRequest

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

Overview

The charge amount from the subscriber.

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(note:, capture_type:, amount:) ⇒ CaptureSubscriptionRequest

Returns a new instance of CaptureSubscriptionRequest.



44
45
46
47
48
 
# File 'lib/paypal_server_sdk/models/capture_subscription_request.rb', line 44

def initialize(note:, capture_type:, amount:)
  @note = note
  @capture_type = capture_type
  @amount = amount
end

Instance Attribute Details

#amount ⇒ Money

The currency and amount for a financial transaction, such as a balance or payment due.

Returns:



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

def amount
  @amount
end

#capture_type ⇒ CaptureType

The type of capture.

Returns:



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

def capture_type
  @capture_type
end

#note ⇒ String

The reason or note for the subscription charge.

Returns:

  • (String) 


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

def note
  @note
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/paypal_server_sdk/models/capture_subscription_request.rb', line 51

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  note = hash.key?('note') ? hash['note'] : nil
  capture_type = hash.key?('capture_type') ? hash['capture_type'] : nil
  amount = Money.from_hash(hash['amount']) if hash['amount']

  # Create object from extracted values.
  CaptureSubscriptionRequest.new(note: note,
                                 capture_type: capture_type,
                                 amount: amount)
end

.names ⇒ Object

A mapping from model property names to API property names.



26
27
28
29
30
31
32
 
# File 'lib/paypal_server_sdk/models/capture_subscription_request.rb', line 26

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

.nullables ⇒ Object

An array for nullable fields



40
41
42
 
# File 'lib/paypal_server_sdk/models/capture_subscription_request.rb', line 40

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



35
36
37
 
# File 'lib/paypal_server_sdk/models/capture_subscription_request.rb', line 35

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



72
73
74
75
76
 
# File 'lib/paypal_server_sdk/models/capture_subscription_request.rb', line 72

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} note: #{@note.inspect}, capture_type: #{@capture_type.inspect}, amount:"\
  " #{@amount.inspect}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



66
67
68
69
 
# File 'lib/paypal_server_sdk/models/capture_subscription_request.rb', line 66

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