paypal-server-sdk 1.1.0 → 2.1.0

data/lib/paypal_server_sdk/models/activate_subscription_request.rb

@@ -0,0 +1,63 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The activate subscription request details.
+  class ActivateSubscriptionRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The reason for activation of a subscription. Required to reactivate the
+    # subscription.
+    # @return [String]
+    attr_accessor :reason
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['reason'] = 'reason'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        reason
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(reason: SKIP)
+      @reason = reason unless reason == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      reason = hash.key?('reason') ? hash['reason'] : SKIP
+
+      # Create object from extracted values.
+      ActivateSubscriptionRequest.new(reason: reason)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} reason: #{@reason}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} reason: #{@reason.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/activity_timestamps.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # The date and time stamps that are common to authorized payment, captured

data/lib/paypal_server_sdk/models/address.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # The portable international postal address. Maps to

data/lib/paypal_server_sdk/models/amount_breakdown.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # The breakdown of the amount. Breakdown provides details such as total item
@@ -41,8 +41,8 @@ module PaypalServerSdk
     # @return [Money]
     attr_accessor :shipping_discount
 
-    # The currency and amount for a financial transaction, such as a balance or
-    # payment due.
+    # The discount amount and currency code. For list of supported currencies
+    # and decimal precision, see the PayPal REST APIs Currency Codes.
     # @return [Money]
     attr_accessor :discount
 

data/lib/paypal_server_sdk/models/amount_with_breakdown.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # The total order amount with an optional breakdown that provides details,

data/lib/paypal_server_sdk/models/app_switch_context.rb

@@ -0,0 +1,74 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Merchant provided details of the native app or mobile web browser to
+  # facilitate buyer's app switch to the PayPal consumer app.
+  class AppSwitchContext < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Merchant provided, buyer's native app preferences to app switch to the
+    # PayPal consumer app.
+    # @return [NativeAppContext]
+    attr_accessor :native_app
+
+    # Buyer's mobile web browser context to app switch to the PayPal consumer
+    # app.
+    # @return [MobileWebContext]
+    attr_accessor :mobile_web
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['native_app'] = 'native_app'
+      @_hash['mobile_web'] = 'mobile_web'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        native_app
+        mobile_web
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(native_app: SKIP, mobile_web: SKIP)
+      @native_app = native_app unless native_app == SKIP
+      @mobile_web = mobile_web unless mobile_web == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      native_app = NativeAppContext.from_hash(hash['native_app']) if hash['native_app']
+      mobile_web = MobileWebContext.from_hash(hash['mobile_web']) if hash['mobile_web']
+
+      # Create object from extracted values.
+      AppSwitchContext.new(native_app: native_app,
+                           mobile_web: mobile_web)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} native_app: #{@native_app}, mobile_web: #{@mobile_web}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} native_app: #{@native_app.inspect}, mobile_web: #{@mobile_web.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/apple_pay_attributes.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # Additional attributes associated with apple pay.

data/lib/paypal_server_sdk/models/apple_pay_attributes_response.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # Additional attributes associated with the use of Apple Pay.

data/lib/paypal_server_sdk/models/apple_pay_card.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # The payment card to be used to fund a payment. Can be a credit or debit

data/lib/paypal_server_sdk/models/apple_pay_card_response.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # The Card from Apple Pay Wallet used to fund the payment.

data/lib/paypal_server_sdk/models/apple_pay_decrypted_token_data.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # Information about the Payment data obtained by decrypting Apple Pay token.

data/lib/paypal_server_sdk/models/apple_pay_experience_context.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # Customizes the payer experience during the approval process for the payment.

data/lib/paypal_server_sdk/models/apple_pay_payment_data.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # Information about the decrypted apple pay payment data for the token like

data/lib/paypal_server_sdk/models/apple_pay_payment_data_type.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # Indicates the type of payment data passed, in case of Non China the payment
@@ -24,5 +24,18 @@ module PaypalServerSdk
 
       true
     end
+
+    def self.from_value(value, default_value = ENUM_3DSECURE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enum_3dsecure' then ENUM_3DSECURE
+      when 'emv' then EMV
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/paypal_server_sdk/models/apple_pay_payment_object.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # Information needed to pay using ApplePay.

data/lib/paypal_server_sdk/models/apple_pay_payment_token.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # A resource representing a response for Apple Pay.

data/lib/paypal_server_sdk/models/apple_pay_request.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # Information needed to pay using ApplePay.

data/lib/paypal_server_sdk/models/apple_pay_request_card.rb

@@ -0,0 +1,88 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The payment card to be used to fund a payment. Can be a credit or debit
+  # card.
+  class ApplePayRequestCard < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Type of card. i.e Credit, Debit and so on.
+    # @return [CardType]
+    attr_accessor :type
+
+    # The card network or brand. Applies to credit, debit, gift, and payment
+    # cards.
+    # @return [CardBrand]
+    attr_accessor :brand
+
+    # The portable international postal address. Maps to
+    # [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/
+    # wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls:
+    # the autocomplete
+    # attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-co
+    # ntrols-the-autocomplete-attribute).
+    # @return [Address]
+    attr_accessor :billing_address
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['brand'] = 'brand'
+      @_hash['billing_address'] = 'billing_address'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        brand
+        billing_address
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type: SKIP, brand: SKIP, billing_address: SKIP)
+      @type = type unless type == SKIP
+      @brand = brand unless brand == SKIP
+      @billing_address = billing_address unless billing_address == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      type = hash.key?('type') ? hash['type'] : SKIP
+      brand = hash.key?('brand') ? hash['brand'] : SKIP
+      billing_address = Address.from_hash(hash['billing_address']) if hash['billing_address']
+
+      # Create object from extracted values.
+      ApplePayRequestCard.new(type: type,
+                              brand: brand,
+                              billing_address: billing_address)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}, brand: #{@brand}, billing_address: #{@billing_address}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type.inspect}, brand: #{@brand.inspect}, billing_address:"\
+      " #{@billing_address.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/apple_pay_tokenized_card.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # The payment card to use to fund a payment. Can be a credit or debit card.
@@ -22,8 +22,7 @@ module PaypalServerSdk
     # @return [String]
     attr_accessor :expiry
 
-    # The card network or brand. Applies to credit, debit, gift, and payment
-    # cards.
+    # The card brand or network. Typically used in the response.
     # @return [CardBrand]
     attr_accessor :card_type
 

data/lib/paypal_server_sdk/models/application_context_user_action.rb

@@ -0,0 +1,42 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Configures the label name to `Continue` or `Subscribe Now` for subscription
+  # consent experience.
+  class ApplicationContextUserAction
+    APPLICATION_CONTEXT_USER_ACTION = [
+      # After you redirect the customer to the PayPal subscription consent page,
+      # a Continue button appears. Use this option when you want to control the
+      # activation of the subscription and do not want PayPal to activate the
+      # subscription.
+      CONTINUE = 'CONTINUE'.freeze,
+
+      # After you redirect the customer to the PayPal subscription consent page,
+      # a Subscribe Now button appears. Use this option when you want PayPal to
+      # activate the subscription.
+      SUBSCRIBE_NOW = 'SUBSCRIBE_NOW'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CONTINUE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'continue' then CONTINUE
+      when 'subscribe_now' then SUBSCRIBE_NOW
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/assurance_details.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # Information about cardholder possession validation and cardholder

data/lib/paypal_server_sdk/models/auction_information.rb

@@ -0,0 +1,100 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The auction information.
+  class AuctionInformation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the auction site.
+    # @return [String]
+    attr_accessor :auction_site
+
+    # The auction site URL.
+    # @return [String]
+    attr_accessor :auction_item_site
+
+    # 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.
+    # @return [String]
+    attr_accessor :auction_buyer_id
+
+    # The date and time, in [Internet date and time
+    # format](https://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.
+    # @return [String]
+    attr_accessor :auction_closing_date
+
+    # A mapping from model property names to API property names.
+    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
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        auction_site
+        auction_item_site
+        auction_buyer_id
+        auction_closing_date
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    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
+
+    # Creates an instance of the object from a hash.
+    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
+
+    # Provides a human-readable string representation of the object.
+    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
+
+    # Provides a debugging-friendly string with detailed object information.
+    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
+  end
+end

data/lib/paypal_server_sdk/models/authentication_response.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # Results of Authentication such as 3D Secure.

data/lib/paypal_server_sdk/models/authorization.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # The authorized payment transaction.
@@ -39,7 +39,7 @@ module PaypalServerSdk
     attr_accessor :custom_id
 
     # Reference values used by the card network to identify a transaction.
-    # @return [NetworkTransactionReference]
+    # @return [NetworkTransaction]
     attr_accessor :network_transaction_reference
 
     # The level of protection offered as defined by [PayPal Seller Protection
@@ -152,7 +152,7 @@ module PaypalServerSdk
       invoice_id = hash.key?('invoice_id') ? hash['invoice_id'] : SKIP
       custom_id = hash.key?('custom_id') ? hash['custom_id'] : SKIP
       if hash['network_transaction_reference']
-        network_transaction_reference = NetworkTransactionReference.from_hash(hash['network_transaction_reference'])
+        network_transaction_reference = NetworkTransaction.from_hash(hash['network_transaction_reference'])
       end
       seller_protection = SellerProtection.from_hash(hash['seller_protection']) if
         hash['seller_protection']

data/lib/paypal_server_sdk/models/authorization_incomplete_reason.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # The reason why the authorized status is `PENDING`.
@@ -19,5 +19,18 @@ module PaypalServerSdk
 
       true
     end
+
+    def self.from_value(value, default_value = PENDING_REVIEW)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'pending_review' then PENDING_REVIEW
+      when 'declined_by_risk_fraud_filters' then DECLINED_BY_RISK_FRAUD_FILTERS
+      else
+        default_value
+      end
+    end
   end
 end