paypal-server-sdk 1.1.0 → 2.0.0

data/lib/paypal_server_sdk/models/plan_details.rb

@@ -0,0 +1,147 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The plan details.
+  class PlanDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID for the product.
+    # @return [String]
+    attr_accessor :product_id
+
+    # The plan name.
+    # @return [String]
+    attr_accessor :name
+
+    # The detailed description of the plan.
+    # @return [String]
+    attr_accessor :description
+
+    # An array of billing cycles for trial billing and regular billing. A plan
+    # can have at most two trial cycles and only one regular cycle.
+    # @return [Array[SubscriptionBillingCycle]]
+    attr_accessor :billing_cycles
+
+    # The payment preferences for a subscription.
+    # @return [PaymentPreferences]
+    attr_accessor :payment_preferences
+
+    # The merchant preferences for a subscription.
+    # @return [MerchantPreferences]
+    attr_accessor :merchant_preferences
+
+    # The tax details.
+    # @return [Taxes]
+    attr_accessor :taxes
+
+    # Indicates whether you can subscribe to this plan by providing a quantity
+    # for the goods or service.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :quantity_supported
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['product_id'] = 'product_id'
+      @_hash['name'] = 'name'
+      @_hash['description'] = 'description'
+      @_hash['billing_cycles'] = 'billing_cycles'
+      @_hash['payment_preferences'] = 'payment_preferences'
+      @_hash['merchant_preferences'] = 'merchant_preferences'
+      @_hash['taxes'] = 'taxes'
+      @_hash['quantity_supported'] = 'quantity_supported'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        product_id
+        name
+        description
+        billing_cycles
+        payment_preferences
+        merchant_preferences
+        taxes
+        quantity_supported
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(product_id: SKIP, name: SKIP, description: SKIP,
+                   billing_cycles: SKIP, payment_preferences: SKIP,
+                   merchant_preferences: SKIP, taxes: SKIP,
+                   quantity_supported: false)
+      @product_id = product_id unless product_id == SKIP
+      @name = name unless name == SKIP
+      @description = description unless description == SKIP
+      @billing_cycles = billing_cycles unless billing_cycles == SKIP
+      @payment_preferences = payment_preferences unless payment_preferences == SKIP
+      @merchant_preferences = merchant_preferences unless merchant_preferences == SKIP
+      @taxes = taxes unless taxes == SKIP
+      @quantity_supported = quantity_supported unless quantity_supported == 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.
+      product_id = hash.key?('product_id') ? hash['product_id'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      billing_cycles = nil
+      unless hash['billing_cycles'].nil?
+        billing_cycles = []
+        hash['billing_cycles'].each do |structure|
+          billing_cycles << (SubscriptionBillingCycle.from_hash(structure) if structure)
+        end
+      end
+
+      billing_cycles = SKIP unless hash.key?('billing_cycles')
+      payment_preferences = PaymentPreferences.from_hash(hash['payment_preferences']) if
+        hash['payment_preferences']
+      merchant_preferences = MerchantPreferences.from_hash(hash['merchant_preferences']) if
+        hash['merchant_preferences']
+      taxes = Taxes.from_hash(hash['taxes']) if hash['taxes']
+      quantity_supported = hash['quantity_supported'] ||= false
+
+      # Create object from extracted values.
+      PlanDetails.new(product_id: product_id,
+                      name: name,
+                      description: description,
+                      billing_cycles: billing_cycles,
+                      payment_preferences: payment_preferences,
+                      merchant_preferences: merchant_preferences,
+                      taxes: taxes,
+                      quantity_supported: quantity_supported)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} product_id: #{@product_id}, name: #{@name}, description: #{@description},"\
+      " billing_cycles: #{@billing_cycles}, payment_preferences: #{@payment_preferences},"\
+      " merchant_preferences: #{@merchant_preferences}, taxes: #{@taxes}, quantity_supported:"\
+      " #{@quantity_supported}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} product_id: #{@product_id.inspect}, name: #{@name.inspect}, description:"\
+      " #{@description.inspect}, billing_cycles: #{@billing_cycles.inspect}, payment_preferences:"\
+      " #{@payment_preferences.inspect}, merchant_preferences: #{@merchant_preferences.inspect},"\
+      " taxes: #{@taxes.inspect}, quantity_supported: #{@quantity_supported.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/plan_override.rb

@@ -0,0 +1,96 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # An inline plan object to customise the subscription. You can override plan
+  # level default attributes by providing customised values for the subscription
+  # in this object.
+  class PlanOverride < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of billing cycles for trial billing and regular billing. The
+    # subscription billing cycle definition has to adhere to the plan billing
+    # cycle definition.
+    # @return [Array[BillingCycleOverride]]
+    attr_accessor :billing_cycles
+
+    # The payment preferences to override at subscription level.
+    # @return [PaymentPreferencesOverride]
+    attr_accessor :payment_preferences
+
+    # The tax details.
+    # @return [TaxesOverride]
+    attr_accessor :taxes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['billing_cycles'] = 'billing_cycles'
+      @_hash['payment_preferences'] = 'payment_preferences'
+      @_hash['taxes'] = 'taxes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        billing_cycles
+        payment_preferences
+        taxes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(billing_cycles: SKIP, payment_preferences: SKIP, taxes: SKIP)
+      @billing_cycles = billing_cycles unless billing_cycles == SKIP
+      @payment_preferences = payment_preferences unless payment_preferences == SKIP
+      @taxes = taxes unless taxes == 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
+      billing_cycles = nil
+      unless hash['billing_cycles'].nil?
+        billing_cycles = []
+        hash['billing_cycles'].each do |structure|
+          billing_cycles << (BillingCycleOverride.from_hash(structure) if structure)
+        end
+      end
+
+      billing_cycles = SKIP unless hash.key?('billing_cycles')
+      payment_preferences = PaymentPreferencesOverride.from_hash(hash['payment_preferences']) if
+        hash['payment_preferences']
+      taxes = TaxesOverride.from_hash(hash['taxes']) if hash['taxes']
+
+      # Create object from extracted values.
+      PlanOverride.new(billing_cycles: billing_cycles,
+                       payment_preferences: payment_preferences,
+                       taxes: taxes)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} billing_cycles: #{@billing_cycles}, payment_preferences:"\
+      " #{@payment_preferences}, taxes: #{@taxes}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} billing_cycles: #{@billing_cycles.inspect}, payment_preferences:"\
+      " #{@payment_preferences.inspect}, taxes: #{@taxes.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/plan_request.rb

@@ -0,0 +1,154 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The create plan request details.
+  class PlanRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the product created through Catalog Products API.
+    # @return [String]
+    attr_accessor :product_id
+
+    # The plan name.
+    # @return [String]
+    attr_accessor :name
+
+    # The initial state of the plan. Allowed input values are CREATED and
+    # ACTIVE.
+    # @return [PlanRequestStatus]
+    attr_accessor :status
+
+    # The detailed description of the plan.
+    # @return [String]
+    attr_accessor :description
+
+    # An array of billing cycles for trial billing and regular billing. A plan
+    # can have at most two trial cycles and only one regular cycle.
+    # @return [Array[SubscriptionBillingCycle]]
+    attr_accessor :billing_cycles
+
+    # The payment preferences for a subscription.
+    # @return [PaymentPreferences]
+    attr_accessor :payment_preferences
+
+    # The merchant preferences for a subscription.
+    # @return [MerchantPreferences]
+    attr_accessor :merchant_preferences
+
+    # The tax details.
+    # @return [Taxes]
+    attr_accessor :taxes
+
+    # Indicates whether you can subscribe to this plan by providing a quantity
+    # for the goods or service.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :quantity_supported
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['product_id'] = 'product_id'
+      @_hash['name'] = 'name'
+      @_hash['status'] = 'status'
+      @_hash['description'] = 'description'
+      @_hash['billing_cycles'] = 'billing_cycles'
+      @_hash['payment_preferences'] = 'payment_preferences'
+      @_hash['merchant_preferences'] = 'merchant_preferences'
+      @_hash['taxes'] = 'taxes'
+      @_hash['quantity_supported'] = 'quantity_supported'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        status
+        description
+        merchant_preferences
+        taxes
+        quantity_supported
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(product_id:, name:, billing_cycles:, payment_preferences:,
+                   status: PlanRequestStatus::ACTIVE, description: SKIP,
+                   merchant_preferences: SKIP, taxes: SKIP,
+                   quantity_supported: false)
+      @product_id = product_id
+      @name = name
+      @status = status unless status == SKIP
+      @description = description unless description == SKIP
+      @billing_cycles = billing_cycles
+      @payment_preferences = payment_preferences
+      @merchant_preferences = merchant_preferences unless merchant_preferences == SKIP
+      @taxes = taxes unless taxes == SKIP
+      @quantity_supported = quantity_supported unless quantity_supported == 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.
+      product_id = hash.key?('product_id') ? hash['product_id'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      # Parameter is an array, so we need to iterate through it
+      billing_cycles = nil
+      unless hash['billing_cycles'].nil?
+        billing_cycles = []
+        hash['billing_cycles'].each do |structure|
+          billing_cycles << (SubscriptionBillingCycle.from_hash(structure) if structure)
+        end
+      end
+
+      billing_cycles = nil unless hash.key?('billing_cycles')
+      payment_preferences = PaymentPreferences.from_hash(hash['payment_preferences']) if
+        hash['payment_preferences']
+      status = hash['status'] ||= PlanRequestStatus::ACTIVE
+      description = hash.key?('description') ? hash['description'] : SKIP
+      merchant_preferences = MerchantPreferences.from_hash(hash['merchant_preferences']) if
+        hash['merchant_preferences']
+      taxes = Taxes.from_hash(hash['taxes']) if hash['taxes']
+      quantity_supported = hash['quantity_supported'] ||= false
+
+      # Create object from extracted values.
+      PlanRequest.new(product_id: product_id,
+                      name: name,
+                      billing_cycles: billing_cycles,
+                      payment_preferences: payment_preferences,
+                      status: status,
+                      description: description,
+                      merchant_preferences: merchant_preferences,
+                      taxes: taxes,
+                      quantity_supported: quantity_supported)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} product_id: #{@product_id}, name: #{@name}, status: #{@status},"\
+      " description: #{@description}, billing_cycles: #{@billing_cycles}, payment_preferences:"\
+      " #{@payment_preferences}, merchant_preferences: #{@merchant_preferences}, taxes: #{@taxes},"\
+      " quantity_supported: #{@quantity_supported}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} product_id: #{@product_id.inspect}, name: #{@name.inspect}, status:"\
+      " #{@status.inspect}, description: #{@description.inspect}, billing_cycles:"\
+      " #{@billing_cycles.inspect}, payment_preferences: #{@payment_preferences.inspect},"\
+      " merchant_preferences: #{@merchant_preferences.inspect}, taxes: #{@taxes.inspect},"\
+      " quantity_supported: #{@quantity_supported.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/plan_request_status.rb

@@ -0,0 +1,28 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The initial state of the plan. Allowed input values are CREATED and ACTIVE.
+  class PlanRequestStatus
+    PLAN_REQUEST_STATUS = [
+      # The plan was created. You cannot create subscriptions for a plan in this
+      # state.
+      CREATED = 'CREATED'.freeze,
+
+      # The plan is inactive.
+      INACTIVE = 'INACTIVE'.freeze,
+
+      # The plan is active. You can only create subscriptions for a plan in this
+      # state.
+      ACTIVE = 'ACTIVE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/platform_fee.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 platform or partner fee, commission, or brokerage fee that is associated

data/lib/paypal_server_sdk/models/pricing_model.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 pricing model for the billing cycle.

data/lib/paypal_server_sdk/models/pricing_scheme.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 pricing scheme details.

data/lib/paypal_server_sdk/models/pricing_tier.rb

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

data/lib/paypal_server_sdk/models/processor_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 processor response information for payment requests, such as direct

data/lib/paypal_server_sdk/models/processor_response_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
   # Processor response code for the non-PayPal payment processor errors.

data/lib/paypal_server_sdk/models/purchase_unit.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 purchase unit details. Used to capture required information for the

data/lib/paypal_server_sdk/models/purchase_unit_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
   # The purchase unit request. Includes required information for the payment
@@ -38,11 +38,14 @@ module PaypalServerSdk
     # @return [PaymentInstruction]
     attr_accessor :payment_instruction
 
-    # The purchase description. The maximum length of the character is dependent
-    # on the type of characters used. The character length is specified assuming
-    # a US ASCII character. Depending on type of character; (e.g. accented
-    # character, Japanese characters) the number of characters that that can be
-    # specified as input might not equal the permissible max length.
+    # This field supports up to 3,000 characters, but any content beyond 127
+    # characters (including spaces) will be truncated. The 127 character limit
+    # is reflected in the response representation of this field. The purchase
+    # description. The maximum length of the character is dependent on the type
+    # of characters used. The character length is specified assuming a US ASCII
+    # character. Depending on type of character; (e.g. accented character,
+    # Japanese characters) the number of characters that that can be specified
+    # as input might not equal the permissible max length.
     # @return [String]
     attr_accessor :description
 
@@ -54,14 +57,21 @@ module PaypalServerSdk
 
     # The API caller-provided external invoice number for this order. Appears in
     # both the payer's transaction history and the emails that the payer
-    # receives.
+    # receives. invoice_id values are required to be unique within each merchant
+    # account by default. Although the uniqueness validation is configurable,
+    # disabling this behavior will remove the account's ability to use
+    # invoice_id in other APIs as an identifier. It is highly recommended to
+    # keep a unique invoice_id for each Order.
     # @return [String]
     attr_accessor :invoice_id
 
-    # The soft descriptor is the dynamic text used to construct the statement
-    # descriptor that appears on a payer's card statement. If an Order is paid
-    # using the "PayPal Wallet", the statement descriptor will appear in
-    # following format on the payer's card statement:
+    # This field supports up to 127 characters, but any content beyond 22
+    # characters (including spaces) will be truncated. The 22 character limit is
+    # reflected in the response representation of this field. The soft
+    # descriptor is the dynamic text used to construct the statement descriptor
+    # that appears on a payer's card statement. If an Order is paid using the
+    # "PayPal Wallet", the statement descriptor will appear in following format
+    # on the payer's card statement:
     # PAYPAL_prefix+(space)+merchant_descriptor+(space)+ soft_descriptor Note:
     # The merchant descriptor is the descriptor of the merchant’s payment
     # receiving preferences which can be seen by logging into the merchant
@@ -75,7 +85,7 @@ module PaypalServerSdk
     attr_accessor :soft_descriptor
 
     # An array of items that the customer purchases from the merchant.
-    # @return [Array[Item]]
+    # @return [Array[ItemRequest]]
     attr_accessor :items
 
     # The shipping details.
@@ -163,7 +173,7 @@ module PaypalServerSdk
       unless hash['items'].nil?
         items = []
         hash['items'].each do |structure|
-          items << (Item.from_hash(structure) if structure)
+          items << (ItemRequest.from_hash(structure) if structure)
         end
       end