Class: PaypalServerSdk::MerchantPreferences

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

Overview

The merchant preferences for a subscription.

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(return_url: SKIP, cancel_url: SKIP) ⇒ MerchantPreferences

Returns a new instance of MerchantPreferences.



43
44
45
46
 
# File 'lib/paypal_server_sdk/models/merchant_preferences.rb', line 43

def initialize(return_url: SKIP, cancel_url: SKIP)
  @return_url = return_url unless return_url == SKIP
  @cancel_url = cancel_url unless cancel_url == SKIP
end

Instance Attribute Details

#cancel_url ⇒ String

The URL where the customer is redirected after the customer cancels the payment.

Returns:

  • (String) 


20
21
22
 
# File 'lib/paypal_server_sdk/models/merchant_preferences.rb', line 20

def cancel_url
  @cancel_url
end

#return_url ⇒ String

The URL where the customer is redirected after the customer approves the payment.

Returns:

  • (String) 


15
16
17
 
# File 'lib/paypal_server_sdk/models/merchant_preferences.rb', line 15

def return_url
  @return_url
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/paypal_server_sdk/models/merchant_preferences.rb', line 49

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  return_url = hash.key?('return_url') ? hash['return_url'] : SKIP
  cancel_url = hash.key?('cancel_url') ? hash['cancel_url'] : SKIP

  # Create object from extracted values.
  MerchantPreferences.new(return_url: return_url,
                          cancel_url: cancel_url)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

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

.nullables ⇒ Object

An array for nullable fields



39
40
41
 
# File 'lib/paypal_server_sdk/models/merchant_preferences.rb', line 39

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  %w[
    return_url
    cancel_url
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



68
69
70
71
 
# File 'lib/paypal_server_sdk/models/merchant_preferences.rb', line 68

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



62
63
64
65
 
# File 'lib/paypal_server_sdk/models/merchant_preferences.rb', line 62

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