paypal-server-sdk 1.0.0 → 2.0.0

data/lib/paypal_server_sdk/models/item_request.rb

@@ -0,0 +1,163 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The details for the items to be purchased.
+  class ItemRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The item name or title.
+    # @return [String]
+    attr_accessor :name
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :unit_amount
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :tax
+
+    # The item quantity. Must be a whole number.
+    # @return [String]
+    attr_accessor :quantity
+
+    # This field supports up to 4000 characters, but any content beyond 2048
+    # characters (including spaces) will be truncated. The 2048 character limit
+    # is reflected in the response representation of this field.
+    # @return [String]
+    attr_accessor :description
+
+    # The stock keeping unit (SKU) for the item.
+    # @return [String]
+    attr_accessor :sku
+
+    # The URL to the item being purchased. Visible to buyer and used in buyer
+    # experiences.
+    # @return [String]
+    attr_accessor :url
+
+    # The item category type.
+    # @return [ItemCategory]
+    attr_accessor :category
+
+    # The URL of the item's image. File type and size restrictions apply. An
+    # image that violates these restrictions will not be honored.
+    # @return [String]
+    attr_accessor :image_url
+
+    # The Universal Product Code of the item.
+    # @return [UniversalProductCode]
+    attr_accessor :upc
+
+    # Metadata for merchant-managed recurring billing plans. Valid only during
+    # the saved payment method token or billing agreement creation.
+    # @return [OrderBillingPlan]
+    attr_accessor :billing_plan
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['unit_amount'] = 'unit_amount'
+      @_hash['tax'] = 'tax'
+      @_hash['quantity'] = 'quantity'
+      @_hash['description'] = 'description'
+      @_hash['sku'] = 'sku'
+      @_hash['url'] = 'url'
+      @_hash['category'] = 'category'
+      @_hash['image_url'] = 'image_url'
+      @_hash['upc'] = 'upc'
+      @_hash['billing_plan'] = 'billing_plan'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tax
+        description
+        sku
+        url
+        category
+        image_url
+        upc
+        billing_plan
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name:, unit_amount:, quantity:, tax: SKIP, description: SKIP,
+                   sku: SKIP, url: SKIP, category: SKIP, image_url: SKIP,
+                   upc: SKIP, billing_plan: SKIP)
+      @name = name
+      @unit_amount = unit_amount
+      @tax = tax unless tax == SKIP
+      @quantity = quantity
+      @description = description unless description == SKIP
+      @sku = sku unless sku == SKIP
+      @url = url unless url == SKIP
+      @category = category unless category == SKIP
+      @image_url = image_url unless image_url == SKIP
+      @upc = upc unless upc == SKIP
+      @billing_plan = billing_plan unless billing_plan == 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.
+      name = hash.key?('name') ? hash['name'] : nil
+      unit_amount = Money.from_hash(hash['unit_amount']) if hash['unit_amount']
+      quantity = hash.key?('quantity') ? hash['quantity'] : nil
+      tax = Money.from_hash(hash['tax']) if hash['tax']
+      description = hash.key?('description') ? hash['description'] : SKIP
+      sku = hash.key?('sku') ? hash['sku'] : SKIP
+      url = hash.key?('url') ? hash['url'] : SKIP
+      category = hash.key?('category') ? hash['category'] : SKIP
+      image_url = hash.key?('image_url') ? hash['image_url'] : SKIP
+      upc = UniversalProductCode.from_hash(hash['upc']) if hash['upc']
+      billing_plan = OrderBillingPlan.from_hash(hash['billing_plan']) if hash['billing_plan']
+
+      # Create object from extracted values.
+      ItemRequest.new(name: name,
+                      unit_amount: unit_amount,
+                      quantity: quantity,
+                      tax: tax,
+                      description: description,
+                      sku: sku,
+                      url: url,
+                      category: category,
+                      image_url: image_url,
+                      upc: upc,
+                      billing_plan: billing_plan)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, unit_amount: #{@unit_amount}, tax: #{@tax}, quantity:"\
+      " #{@quantity}, description: #{@description}, sku: #{@sku}, url: #{@url}, category:"\
+      " #{@category}, image_url: #{@image_url}, upc: #{@upc}, billing_plan: #{@billing_plan}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, unit_amount: #{@unit_amount.inspect}, tax:"\
+      " #{@tax.inspect}, quantity: #{@quantity.inspect}, description: #{@description.inspect},"\
+      " sku: #{@sku.inspect}, url: #{@url.inspect}, category: #{@category.inspect}, image_url:"\
+      " #{@image_url.inspect}, upc: #{@upc.inspect}, billing_plan: #{@billing_plan.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/last_payment_details.rb

@@ -0,0 +1,75 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # LastPaymentDetails Model.
+  class LastPaymentDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :amount
+
+    # 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 :time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['time'] = 'time'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        amount
+        time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount: SKIP, time: SKIP)
+      @amount = amount unless amount == SKIP
+      @time = time unless time == 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.
+      amount = Money.from_hash(hash['amount']) if hash['amount']
+      time = hash.key?('time') ? hash['time'] : SKIP
+
+      # Create object from extracted values.
+      LastPaymentDetails.new(amount: amount,
+                             time: time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount}, time: #{@time}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount.inspect}, time: #{@time.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/level2_card_processing_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
   # The level 2 card processing data collections. If your merchant account has

data/lib/paypal_server_sdk/models/level3_card_processing_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
   # The level 3 card processing data collections, If your merchant account has

data/lib/paypal_server_sdk/models/liability_shift_indicator.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
   # Liability shift indicator. The outcome of the issuer's authentication.

data/lib/paypal_server_sdk/models/line_item.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 line items for this purchase. If your merchant account has been
@@ -41,6 +41,11 @@ module PaypalServerSdk
     # @return [UniversalProductCode]
     attr_accessor :upc
 
+    # Metadata for merchant-managed recurring billing plans. Valid only during
+    # the saved payment method token or billing agreement creation.
+    # @return [OrderBillingPlan]
+    attr_accessor :billing_plan
+
     # The currency and amount for a financial transaction, such as a balance or
     # payment due.
     # @return [Money]
@@ -87,6 +92,7 @@ module PaypalServerSdk
       @_hash['url'] = 'url'
       @_hash['image_url'] = 'image_url'
       @_hash['upc'] = 'upc'
+      @_hash['billing_plan'] = 'billing_plan'
       @_hash['unit_amount'] = 'unit_amount'
       @_hash['tax'] = 'tax'
       @_hash['commodity_code'] = 'commodity_code'
@@ -104,6 +110,7 @@ module PaypalServerSdk
         url
         image_url
         upc
+        billing_plan
         unit_amount
         tax
         commodity_code
@@ -119,9 +126,10 @@ module PaypalServerSdk
     end
 
     def initialize(name:, quantity:, description: SKIP, sku: SKIP, url: SKIP,
-                   image_url: SKIP, upc: SKIP, unit_amount: SKIP, tax: SKIP,
-                   commodity_code: SKIP, discount_amount: SKIP,
-                   total_amount: SKIP, unit_of_measure: SKIP)
+                   image_url: SKIP, upc: SKIP, billing_plan: SKIP,
+                   unit_amount: SKIP, tax: SKIP, commodity_code: SKIP,
+                   discount_amount: SKIP, total_amount: SKIP,
+                   unit_of_measure: SKIP)
       @name = name
       @quantity = quantity
       @description = description unless description == SKIP
@@ -129,6 +137,7 @@ module PaypalServerSdk
       @url = url unless url == SKIP
       @image_url = image_url unless image_url == SKIP
       @upc = upc unless upc == SKIP
+      @billing_plan = billing_plan unless billing_plan == SKIP
       @unit_amount = unit_amount unless unit_amount == SKIP
       @tax = tax unless tax == SKIP
       @commodity_code = commodity_code unless commodity_code == SKIP
@@ -149,6 +158,7 @@ module PaypalServerSdk
       url = hash.key?('url') ? hash['url'] : SKIP
       image_url = hash.key?('image_url') ? hash['image_url'] : SKIP
       upc = UniversalProductCode.from_hash(hash['upc']) if hash['upc']
+      billing_plan = OrderBillingPlan.from_hash(hash['billing_plan']) if hash['billing_plan']
       unit_amount = Money.from_hash(hash['unit_amount']) if hash['unit_amount']
       tax = Money.from_hash(hash['tax']) if hash['tax']
       commodity_code =
@@ -166,6 +176,7 @@ module PaypalServerSdk
                    url: url,
                    image_url: image_url,
                    upc: upc,
+                   billing_plan: billing_plan,
                    unit_amount: unit_amount,
                    tax: tax,
                    commodity_code: commodity_code,
@@ -178,10 +189,10 @@ module PaypalServerSdk
     def to_s
       class_name = self.class.name.split('::').last
       "<#{class_name} name: #{@name}, quantity: #{@quantity}, description: #{@description}, sku:"\
-      " #{@sku}, url: #{@url}, image_url: #{@image_url}, upc: #{@upc}, unit_amount:"\
-      " #{@unit_amount}, tax: #{@tax}, commodity_code: #{@commodity_code}, discount_amount:"\
-      " #{@discount_amount}, total_amount: #{@total_amount}, unit_of_measure:"\
-      " #{@unit_of_measure}>"
+      " #{@sku}, url: #{@url}, image_url: #{@image_url}, upc: #{@upc}, billing_plan:"\
+      " #{@billing_plan}, unit_amount: #{@unit_amount}, tax: #{@tax}, commodity_code:"\
+      " #{@commodity_code}, discount_amount: #{@discount_amount}, total_amount: #{@total_amount},"\
+      " unit_of_measure: #{@unit_of_measure}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
@@ -189,10 +200,10 @@ module PaypalServerSdk
       class_name = self.class.name.split('::').last
       "<#{class_name} name: #{@name.inspect}, quantity: #{@quantity.inspect}, description:"\
       " #{@description.inspect}, sku: #{@sku.inspect}, url: #{@url.inspect}, image_url:"\
-      " #{@image_url.inspect}, upc: #{@upc.inspect}, unit_amount: #{@unit_amount.inspect}, tax:"\
-      " #{@tax.inspect}, commodity_code: #{@commodity_code.inspect}, discount_amount:"\
-      " #{@discount_amount.inspect}, total_amount: #{@total_amount.inspect}, unit_of_measure:"\
-      " #{@unit_of_measure.inspect}>"
+      " #{@image_url.inspect}, upc: #{@upc.inspect}, billing_plan: #{@billing_plan.inspect},"\
+      " unit_amount: #{@unit_amount.inspect}, tax: #{@tax.inspect}, commodity_code:"\
+      " #{@commodity_code.inspect}, discount_amount: #{@discount_amount.inspect}, total_amount:"\
+      " #{@total_amount.inspect}, unit_of_measure: #{@unit_of_measure.inspect}>"
     end
   end
 end

data/lib/paypal_server_sdk/models/link_description.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 request-related [HATEOAS link](/api/rest/responses/#hateoas-links)

data/lib/paypal_server_sdk/models/link_http_method.rb

@@ -1,34 +1,34 @@
 # 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 HTTP method required to make the related call.
   class LinkHttpMethod
     LINK_HTTP_METHOD = [
-      # TODO: Write general description for GET
+      # The HTTP GET method.
       GET = 'GET'.freeze,
 
-      # TODO: Write general description for POST
+      # The HTTP POST method.
       POST = 'POST'.freeze,
 
-      # TODO: Write general description for PUT
+      # The HTTP PUT method.
       PUT = 'PUT'.freeze,
 
-      # TODO: Write general description for DELETE
+      # The HTTP DELETE method.
       DELETE = 'DELETE'.freeze,
 
-      # TODO: Write general description for HEAD
+      # The HTTP HEAD method.
       HEAD = 'HEAD'.freeze,
 
-      # TODO: Write general description for CONNECT
+      # The HTTP CONNECT method.
       CONNECT = 'CONNECT'.freeze,
 
-      # TODO: Write general description for OPTIONS
+      # The HTTP OPTIONS method.
       OPTIONS = 'OPTIONS'.freeze,
 
-      # TODO: Write general description for PATCH
+      # The HTTP PATCH method.
       PATCH = 'PATCH'.freeze
     ].freeze
 

data/lib/paypal_server_sdk/models/merchant_preferences.rb

@@ -0,0 +1,73 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The merchant preferences for a subscription.
+  class MerchantPreferences < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The URL where the customer is redirected after the customer approves the
+    # payment.
+    # @return [String]
+    attr_accessor :return_url
+
+    # The URL where the customer is redirected after the customer cancels the
+    # payment.
+    # @return [String]
+    attr_accessor :cancel_url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['return_url'] = 'return_url'
+      @_hash['cancel_url'] = 'cancel_url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        return_url
+        cancel_url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    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
+
+    # Creates an instance of the object from a hash.
+    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
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} return_url: #{@return_url}, cancel_url: #{@cancel_url}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} return_url: #{@return_url.inspect}, cancel_url: #{@cancel_url.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/mobile_return_flow.rb

@@ -0,0 +1,28 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Merchant preference on how the buyer can navigate back to merchant website
+  # post approving the transaction on the PayPal App.
+  class MobileReturnFlow
+    MOBILE_RETURN_FLOW = [
+      # After payment approval in the PayPal App, buyer will automatically be
+      # redirected to the merchant website.
+      AUTO = 'AUTO'.freeze,
+
+      # After payment approval in the PayPal App, buyer will be asked to
+      # manually navigate back to the merchant website where they started the
+      # transaction from. The buyer is shown a message like 'Return to Merchant'
+      # to return to the source where the transaction actually started.
+      MANUAL = 'MANUAL'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/mobile_web_context.rb

@@ -0,0 +1,76 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Buyer's mobile web browser context to app switch to the PayPal consumer app.
+  class MobileWebContext < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Merchant preference on how the buyer can navigate back to merchant website
+    # post approving the transaction on the PayPal App.
+    # @return [MobileReturnFlow]
+    attr_accessor :return_flow
+
+    # User agent from the request originating from the buyer's device. This will
+    # be used to identify the buyer's operating system and browser versions.
+    # NOTE: Merchants must not alter or modify the buyer's device user agent.
+    # @return [String]
+    attr_accessor :buyer_user_agent
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['return_flow'] = 'return_flow'
+      @_hash['buyer_user_agent'] = 'buyer_user_agent'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        return_flow
+        buyer_user_agent
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(return_flow: MobileReturnFlow::AUTO, buyer_user_agent: SKIP)
+      @return_flow = return_flow unless return_flow == SKIP
+      @buyer_user_agent = buyer_user_agent unless buyer_user_agent == 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.
+      return_flow = hash['return_flow'] ||= MobileReturnFlow::AUTO
+      buyer_user_agent =
+        hash.key?('buyer_user_agent') ? hash['buyer_user_agent'] : SKIP
+
+      # Create object from extracted values.
+      MobileWebContext.new(return_flow: return_flow,
+                           buyer_user_agent: buyer_user_agent)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} return_flow: #{@return_flow}, buyer_user_agent: #{@buyer_user_agent}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} return_flow: #{@return_flow.inspect}, buyer_user_agent:"\
+      " #{@buyer_user_agent.inspect}>"
+    end
+  end
+end