paypal-server-sdk 1.1.0 → 2.0.0

data/lib/paypal_server_sdk/models/transactions_list.rb

@@ -0,0 +1,111 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The list transactions for a subscription request details.
+  class TransactionsList < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of transactions.
+    # @return [Array[SubscriptionTransactionDetails]]
+    attr_accessor :transactions
+
+    # The total number of items.
+    # @return [Integer]
+    attr_accessor :total_items
+
+    # The total number of pages.
+    # @return [Integer]
+    attr_accessor :total_pages
+
+    # An array of request-related [HATEOAS
+    # links](/docs/api/reference/api-responses/#hateoas-links).
+    # @return [Array[LinkDescription]]
+    attr_accessor :links
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transactions'] = 'transactions'
+      @_hash['total_items'] = 'total_items'
+      @_hash['total_pages'] = 'total_pages'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transactions
+        total_items
+        total_pages
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(transactions: SKIP, total_items: SKIP, total_pages: SKIP,
+                   links: SKIP)
+      @transactions = transactions unless transactions == SKIP
+      @total_items = total_items unless total_items == SKIP
+      @total_pages = total_pages unless total_pages == SKIP
+      @links = links unless links == 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.
+      # Parameter is an array, so we need to iterate through it
+      transactions = nil
+      unless hash['transactions'].nil?
+        transactions = []
+        hash['transactions'].each do |structure|
+          transactions << (SubscriptionTransactionDetails.from_hash(structure) if structure)
+        end
+      end
+
+      transactions = SKIP unless hash.key?('transactions')
+      total_items = hash.key?('total_items') ? hash['total_items'] : SKIP
+      total_pages = hash.key?('total_pages') ? hash['total_pages'] : SKIP
+      # 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.
+      TransactionsList.new(transactions: transactions,
+                           total_items: total_items,
+                           total_pages: total_pages,
+                           links: links)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transactions: #{@transactions}, total_items: #{@total_items}, total_pages:"\
+      " #{@total_pages}, links: #{@links}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transactions: #{@transactions.inspect}, total_items:"\
+      " #{@total_items.inspect}, total_pages: #{@total_pages.inspect}, links: #{@links.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/trustly_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 Trustly.

data/lib/paypal_server_sdk/models/trustly_payment_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 Trustly.

data/lib/paypal_server_sdk/models/universal_product_code.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 Universal Product Code of the item.

data/lib/paypal_server_sdk/models/upc_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
   # The Universal Product Code type.

data/lib/paypal_server_sdk/models/update_pricing_scheme.rb

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

data/lib/paypal_server_sdk/models/update_pricing_schemes_request.rb

@@ -0,0 +1,69 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The update pricing scheme request details.
+  class UpdatePricingSchemesRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of pricing schemes.
+    # @return [Array[UpdatePricingScheme]]
+    attr_accessor :pricing_schemes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['pricing_schemes'] = 'pricing_schemes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(pricing_schemes:)
+      @pricing_schemes = pricing_schemes
+    end
+
+    # Creates an instance of the object from a hash.
+    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
+      pricing_schemes = nil
+      unless hash['pricing_schemes'].nil?
+        pricing_schemes = []
+        hash['pricing_schemes'].each do |structure|
+          pricing_schemes << (UpdatePricingScheme.from_hash(structure) if structure)
+        end
+      end
+
+      pricing_schemes = nil unless hash.key?('pricing_schemes')
+
+      # Create object from extracted values.
+      UpdatePricingSchemesRequest.new(pricing_schemes: pricing_schemes)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} pricing_schemes: #{@pricing_schemes}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} pricing_schemes: #{@pricing_schemes.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/usage_pattern.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
   # Expected business/pricing model for the billing agreement., Expected

data/lib/paypal_server_sdk/models/vault_apple_pay_request.rb

@@ -0,0 +1,73 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # A resource representing a request to vault Apple Pay.
+  class VaultApplePayRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Encrypted Apple Pay token, containing card information. This token would
+    # be base64 encoded.
+    # @return [String]
+    attr_accessor :token
+
+    # The payment card to be used to fund a payment. Can be a credit or debit
+    # card.
+    # @return [ApplePayRequestCard]
+    attr_accessor :card
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['token'] = 'token'
+      @_hash['card'] = 'card'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        token
+        card
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(token: SKIP, card: SKIP)
+      @token = token unless token == SKIP
+      @card = card unless card == 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.
+      token = hash.key?('token') ? hash['token'] : SKIP
+      card = ApplePayRequestCard.from_hash(hash['card']) if hash['card']
+
+      # Create object from extracted values.
+      VaultApplePayRequest.new(token: token,
+                               card: card)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} token: #{@token}, card: #{@card}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} token: #{@token.inspect}, card: #{@card.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/{setup_token_card_experience_context.rb → vault_card_experience_context.rb}

@@ -1,11 +1,11 @@
 # 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 Vault creation flow experience for your customers.
-  class SetupTokenCardExperienceContext < BaseModel
+  # A resource representing an experience context of vault a card.
+  class VaultCardExperienceContext < BaseModel
     SKIP = Object.new
     private_constant :SKIP
 
@@ -38,11 +38,15 @@ module PaypalServerSdk
     # @return [String]
     attr_accessor :cancel_url
 
-    # Vault Instruction on action to be performed after a successful payer
-    # approval.
+    # DEPRECATED. Vault Instruction on action to be performed after a successful
+    # payer approval.
     # @return [VaultInstructionAction]
     attr_accessor :vault_instruction
 
+    # User Action on action to be performed after a successful payer approval.
+    # @return [VaultUserAction]
+    attr_accessor :user_action
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
@@ -51,6 +55,7 @@ module PaypalServerSdk
       @_hash['return_url'] = 'return_url'
       @_hash['cancel_url'] = 'cancel_url'
       @_hash['vault_instruction'] = 'vault_instruction'
+      @_hash['user_action'] = 'user_action'
       @_hash
     end
 
@@ -62,6 +67,7 @@ module PaypalServerSdk
         return_url
         cancel_url
         vault_instruction
+        user_action
       ]
     end
 
@@ -70,15 +76,15 @@ module PaypalServerSdk
       []
     end
 
-    def initialize(
-      brand_name: SKIP, locale: SKIP, return_url: SKIP, cancel_url: SKIP,
-      vault_instruction: VaultInstructionAction::ON_CREATE_PAYMENT_TOKENS
-    )
+    def initialize(brand_name: SKIP, locale: SKIP, return_url: SKIP,
+                   cancel_url: SKIP, vault_instruction: SKIP,
+                   user_action: VaultUserAction::CONTINUE)
       @brand_name = brand_name unless brand_name == SKIP
       @locale = locale unless locale == SKIP
       @return_url = return_url unless return_url == SKIP
       @cancel_url = cancel_url unless cancel_url == SKIP
       @vault_instruction = vault_instruction unless vault_instruction == SKIP
+      @user_action = user_action unless user_action == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -91,21 +97,24 @@ module PaypalServerSdk
       return_url = hash.key?('return_url') ? hash['return_url'] : SKIP
       cancel_url = hash.key?('cancel_url') ? hash['cancel_url'] : SKIP
       vault_instruction =
-        hash['vault_instruction'] ||= VaultInstructionAction::ON_CREATE_PAYMENT_TOKENS
+        hash.key?('vault_instruction') ? hash['vault_instruction'] : SKIP
+      user_action = hash['user_action'] ||= VaultUserAction::CONTINUE
 
       # Create object from extracted values.
-      SetupTokenCardExperienceContext.new(brand_name: brand_name,
-                                          locale: locale,
-                                          return_url: return_url,
-                                          cancel_url: cancel_url,
-                                          vault_instruction: vault_instruction)
+      VaultCardExperienceContext.new(brand_name: brand_name,
+                                     locale: locale,
+                                     return_url: return_url,
+                                     cancel_url: cancel_url,
+                                     vault_instruction: vault_instruction,
+                                     user_action: user_action)
     end
 
     # Provides a human-readable string representation of the object.
     def to_s
       class_name = self.class.name.split('::').last
       "<#{class_name} brand_name: #{@brand_name}, locale: #{@locale}, return_url: #{@return_url},"\
-      " cancel_url: #{@cancel_url}, vault_instruction: #{@vault_instruction}>"
+      " cancel_url: #{@cancel_url}, vault_instruction: #{@vault_instruction}, user_action:"\
+      " #{@user_action}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
@@ -113,7 +122,7 @@ module PaypalServerSdk
       class_name = self.class.name.split('::').last
       "<#{class_name} brand_name: #{@brand_name.inspect}, locale: #{@locale.inspect}, return_url:"\
       " #{@return_url.inspect}, cancel_url: #{@cancel_url.inspect}, vault_instruction:"\
-      " #{@vault_instruction.inspect}>"
+      " #{@vault_instruction.inspect}, user_action: #{@user_action.inspect}>"
     end
   end
 end

data/lib/paypal_server_sdk/models/vault_card_verification_method.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 verification method of the card.

data/lib/paypal_server_sdk/models/vault_customer.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
   # This object represents a merchant’s customer, allowing them to store contact

data/lib/paypal_server_sdk/models/vault_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 Vault creation flow experience for your customers.
@@ -39,14 +39,23 @@ module PaypalServerSdk
     attr_accessor :cancel_url
 
     # The shipping preference. This only applies to PayPal payment source.
-    # @return [OrderApplicationContextShippingPreference]
+    # @return [ExperienceContextShippingPreference]
     attr_accessor :shipping_preference
 
-    # Vault Instruction on action to be performed after a successful payer
-    # approval.
+    # DEPRECATED. Vault Instruction on action to be performed after a successful
+    # payer approval.
     # @return [VaultInstructionAction]
     attr_accessor :vault_instruction
 
+    # Merchant provided details of the native app or mobile web browser to
+    # facilitate buyer's app switch to the PayPal consumer app.
+    # @return [AppSwitchContext]
+    attr_accessor :app_switch_context
+
+    # User Action on action to be performed after a successful payer approval.
+    # @return [VaultUserAction]
+    attr_accessor :user_action
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
@@ -56,6 +65,8 @@ module PaypalServerSdk
       @_hash['cancel_url'] = 'cancel_url'
       @_hash['shipping_preference'] = 'shipping_preference'
       @_hash['vault_instruction'] = 'vault_instruction'
+      @_hash['app_switch_context'] = 'app_switch_context'
+      @_hash['user_action'] = 'user_action'
       @_hash
     end
 
@@ -68,6 +79,8 @@ module PaypalServerSdk
         cancel_url
         shipping_preference
         vault_instruction
+        app_switch_context
+        user_action
       ]
     end
 
@@ -78,8 +91,9 @@ module PaypalServerSdk
 
     def initialize(
       brand_name: SKIP, locale: SKIP, return_url: SKIP, cancel_url: SKIP,
-      shipping_preference: OrderApplicationContextShippingPreference::GET_FROM_FILE,
-      vault_instruction: VaultInstructionAction::ON_CREATE_PAYMENT_TOKENS
+      shipping_preference: ExperienceContextShippingPreference::GET_FROM_FILE,
+      vault_instruction: SKIP, app_switch_context: SKIP,
+      user_action: VaultUserAction::CONTINUE
     )
       @brand_name = brand_name unless brand_name == SKIP
       @locale = locale unless locale == SKIP
@@ -87,6 +101,8 @@ module PaypalServerSdk
       @cancel_url = cancel_url unless cancel_url == SKIP
       @shipping_preference = shipping_preference unless shipping_preference == SKIP
       @vault_instruction = vault_instruction unless vault_instruction == SKIP
+      @app_switch_context = app_switch_context unless app_switch_context == SKIP
+      @user_action = user_action unless user_action == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -99,9 +115,12 @@ module PaypalServerSdk
       return_url = hash.key?('return_url') ? hash['return_url'] : SKIP
       cancel_url = hash.key?('cancel_url') ? hash['cancel_url'] : SKIP
       shipping_preference =
-        hash['shipping_preference'] ||= OrderApplicationContextShippingPreference::GET_FROM_FILE
+        hash['shipping_preference'] ||= ExperienceContextShippingPreference::GET_FROM_FILE
       vault_instruction =
-        hash['vault_instruction'] ||= VaultInstructionAction::ON_CREATE_PAYMENT_TOKENS
+        hash.key?('vault_instruction') ? hash['vault_instruction'] : SKIP
+      app_switch_context = AppSwitchContext.from_hash(hash['app_switch_context']) if
+        hash['app_switch_context']
+      user_action = hash['user_action'] ||= VaultUserAction::CONTINUE
 
       # Create object from extracted values.
       VaultExperienceContext.new(brand_name: brand_name,
@@ -109,7 +128,9 @@ module PaypalServerSdk
                                  return_url: return_url,
                                  cancel_url: cancel_url,
                                  shipping_preference: shipping_preference,
-                                 vault_instruction: vault_instruction)
+                                 vault_instruction: vault_instruction,
+                                 app_switch_context: app_switch_context,
+                                 user_action: user_action)
     end
 
     # Provides a human-readable string representation of the object.
@@ -117,7 +138,8 @@ module PaypalServerSdk
       class_name = self.class.name.split('::').last
       "<#{class_name} brand_name: #{@brand_name}, locale: #{@locale}, return_url: #{@return_url},"\
       " cancel_url: #{@cancel_url}, shipping_preference: #{@shipping_preference},"\
-      " vault_instruction: #{@vault_instruction}>"
+      " vault_instruction: #{@vault_instruction}, app_switch_context: #{@app_switch_context},"\
+      " user_action: #{@user_action}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
@@ -125,7 +147,8 @@ module PaypalServerSdk
       class_name = self.class.name.split('::').last
       "<#{class_name} brand_name: #{@brand_name.inspect}, locale: #{@locale.inspect}, return_url:"\
       " #{@return_url.inspect}, cancel_url: #{@cancel_url.inspect}, shipping_preference:"\
-      " #{@shipping_preference.inspect}, vault_instruction: #{@vault_instruction.inspect}>"
+      " #{@shipping_preference.inspect}, vault_instruction: #{@vault_instruction.inspect},"\
+      " app_switch_context: #{@app_switch_context.inspect}, user_action: #{@user_action.inspect}>"
     end
   end
 end

data/lib/paypal_server_sdk/models/vault_instruction.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
   # Base vaulting specification. The object can be extended for specific use

data/lib/paypal_server_sdk/models/vault_instruction_action.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
   # Vault Instruction on action to be performed after a successful payer

data/lib/paypal_server_sdk/models/vault_instruction_base.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
   # Basic vault instruction specification that can be extended by specific