paypal-server-sdk 0.5.0

data/lib/paypal_server_sdk/models/refund_status.rb

@@ -0,0 +1,29 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The status of the refund.
+  class RefundStatus
+    REFUND_STATUS = [
+      # TODO: Write general description for CANCELLED
+      CANCELLED = 'CANCELLED'.freeze,
+
+      # TODO: Write general description for FAILED
+      FAILED = 'FAILED'.freeze,
+
+      # TODO: Write general description for PENDING
+      PENDING = 'PENDING'.freeze,
+
+      # TODO: Write general description for COMPLETED
+      COMPLETED = 'COMPLETED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/refund_status_details.rb

@@ -0,0 +1,50 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The details of the refund status.
+  class RefundStatusDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The reason why the refund has the `PENDING` or `FAILED` status.
+    # @return [RefundIncompleteReason]
+    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.
+      RefundStatusDetails.new(reason: reason)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/refund_status_with_details.rb

@@ -0,0 +1,60 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The refund status with details.
+  class RefundStatusWithDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The status of the refund.
+    # @return [RefundStatus]
+    attr_accessor :status
+
+    # The details of the refund status.
+    # @return [RefundStatusDetails]
+    attr_accessor :status_details
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['status'] = 'status'
+      @_hash['status_details'] = 'status_details'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        status
+        status_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(status: SKIP, status_details: SKIP)
+      @status = status unless status == SKIP
+      @status_details = status_details unless status_details == 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.
+      status = hash.key?('status') ? hash['status'] : SKIP
+      status_details = RefundStatusDetails.from_hash(hash['status_details']) if
+        hash['status_details']
+
+      # Create object from extracted values.
+      RefundStatusWithDetails.new(status: status,
+                                  status_details: status_details)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/related_identifiers.rb

@@ -0,0 +1,69 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Identifiers related to a specific resource.
+  class RelatedIdentifiers < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Order ID related to the resource.
+    # @return [String]
+    attr_accessor :order_id
+
+    # Authorization ID related to the resource.
+    # @return [String]
+    attr_accessor :authorization_id
+
+    # Capture ID related to the resource.
+    # @return [String]
+    attr_accessor :capture_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['order_id'] = 'order_id'
+      @_hash['authorization_id'] = 'authorization_id'
+      @_hash['capture_id'] = 'capture_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        order_id
+        authorization_id
+        capture_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(order_id: SKIP, authorization_id: SKIP, capture_id: SKIP)
+      @order_id = order_id unless order_id == SKIP
+      @authorization_id = authorization_id unless authorization_id == SKIP
+      @capture_id = capture_id unless capture_id == 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.
+      order_id = hash.key?('order_id') ? hash['order_id'] : SKIP
+      authorization_id =
+        hash.key?('authorization_id') ? hash['authorization_id'] : SKIP
+      capture_id = hash.key?('capture_id') ? hash['capture_id'] : SKIP
+
+      # Create object from extracted values.
+      RelatedIdentifiers.new(order_id: order_id,
+                             authorization_id: authorization_id,
+                             capture_id: capture_id)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/seller_payable_breakdown.rb

@@ -0,0 +1,156 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The breakdown of the refund.
+  class SellerPayableBreakdown < 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 :gross_amount
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :paypal_fee
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :paypal_fee_in_receivable_currency
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :net_amount
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :net_amount_in_receivable_currency
+
+    # An array of platform or partner fees, commissions, or brokerage fees for
+    # the refund.
+    # @return [Array[PlatformFee]]
+    attr_accessor :platform_fees
+
+    # An array of breakdown values for the net amount. Returned when the
+    # currency of the refund is different from the currency of the PayPal
+    # account where the payee holds their funds.
+    # @return [Array[NetAmountBreakdownItem]]
+    attr_accessor :net_amount_breakdown
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :total_refunded_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['gross_amount'] = 'gross_amount'
+      @_hash['paypal_fee'] = 'paypal_fee'
+      @_hash['paypal_fee_in_receivable_currency'] =
+        'paypal_fee_in_receivable_currency'
+      @_hash['net_amount'] = 'net_amount'
+      @_hash['net_amount_in_receivable_currency'] =
+        'net_amount_in_receivable_currency'
+      @_hash['platform_fees'] = 'platform_fees'
+      @_hash['net_amount_breakdown'] = 'net_amount_breakdown'
+      @_hash['total_refunded_amount'] = 'total_refunded_amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        gross_amount
+        paypal_fee
+        paypal_fee_in_receivable_currency
+        net_amount
+        net_amount_in_receivable_currency
+        platform_fees
+        net_amount_breakdown
+        total_refunded_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(gross_amount: SKIP, paypal_fee: SKIP,
+                   paypal_fee_in_receivable_currency: SKIP, net_amount: SKIP,
+                   net_amount_in_receivable_currency: SKIP, platform_fees: SKIP,
+                   net_amount_breakdown: SKIP, total_refunded_amount: SKIP)
+      @gross_amount = gross_amount unless gross_amount == SKIP
+      @paypal_fee = paypal_fee unless paypal_fee == SKIP
+      unless paypal_fee_in_receivable_currency == SKIP
+        @paypal_fee_in_receivable_currency =
+          paypal_fee_in_receivable_currency
+      end
+      @net_amount = net_amount unless net_amount == SKIP
+      unless net_amount_in_receivable_currency == SKIP
+        @net_amount_in_receivable_currency =
+          net_amount_in_receivable_currency
+      end
+      @platform_fees = platform_fees unless platform_fees == SKIP
+      @net_amount_breakdown = net_amount_breakdown unless net_amount_breakdown == SKIP
+      @total_refunded_amount = total_refunded_amount unless total_refunded_amount == 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.
+      gross_amount = Money.from_hash(hash['gross_amount']) if hash['gross_amount']
+      paypal_fee = Money.from_hash(hash['paypal_fee']) if hash['paypal_fee']
+      if hash['paypal_fee_in_receivable_currency']
+        paypal_fee_in_receivable_currency = Money.from_hash(hash['paypal_fee_in_receivable_currency'])
+      end
+      net_amount = Money.from_hash(hash['net_amount']) if hash['net_amount']
+      if hash['net_amount_in_receivable_currency']
+        net_amount_in_receivable_currency = Money.from_hash(hash['net_amount_in_receivable_currency'])
+      end
+      # Parameter is an array, so we need to iterate through it
+      platform_fees = nil
+      unless hash['platform_fees'].nil?
+        platform_fees = []
+        hash['platform_fees'].each do |structure|
+          platform_fees << (PlatformFee.from_hash(structure) if structure)
+        end
+      end
+
+      platform_fees = SKIP unless hash.key?('platform_fees')
+      # Parameter is an array, so we need to iterate through it
+      net_amount_breakdown = nil
+      unless hash['net_amount_breakdown'].nil?
+        net_amount_breakdown = []
+        hash['net_amount_breakdown'].each do |structure|
+          net_amount_breakdown << (NetAmountBreakdownItem.from_hash(structure) if structure)
+        end
+      end
+
+      net_amount_breakdown = SKIP unless hash.key?('net_amount_breakdown')
+      total_refunded_amount = Money.from_hash(hash['total_refunded_amount']) if
+        hash['total_refunded_amount']
+
+      # Create object from extracted values.
+      SellerPayableBreakdown.new(gross_amount: gross_amount,
+                                 paypal_fee: paypal_fee,
+                                 paypal_fee_in_receivable_currency: paypal_fee_in_receivable_currency,
+                                 net_amount: net_amount,
+                                 net_amount_in_receivable_currency: net_amount_in_receivable_currency,
+                                 platform_fees: platform_fees,
+                                 net_amount_breakdown: net_amount_breakdown,
+                                 total_refunded_amount: total_refunded_amount)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/seller_protection.rb

@@ -0,0 +1,65 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The level of protection offered as defined by [PayPal Seller Protection for
+  # Merchants](https://www.paypal.com/us/webapps/mpp/security/seller-protection)
+  # .
+  class SellerProtection < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Indicates whether the transaction is eligible for seller protection. For
+    # information, see [PayPal Seller Protection for
+    # Merchants](https://www.paypal.com/us/webapps/mpp/security/seller-protectio
+    # n).
+    # @return [SellerProtectionStatus]
+    attr_accessor :status
+
+    # An array of conditions that are covered for the transaction.
+    # @return [Array[DisputeCategory]]
+    attr_accessor :dispute_categories
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['status'] = 'status'
+      @_hash['dispute_categories'] = 'dispute_categories'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        status
+        dispute_categories
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(status: SKIP, dispute_categories: SKIP)
+      @status = status unless status == SKIP
+      @dispute_categories = dispute_categories unless dispute_categories == 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.
+      status = hash.key?('status') ? hash['status'] : SKIP
+      dispute_categories =
+        hash.key?('dispute_categories') ? hash['dispute_categories'] : SKIP
+
+      # Create object from extracted values.
+      SellerProtection.new(status: status,
+                           dispute_categories: dispute_categories)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/seller_protection_status.rb

@@ -0,0 +1,29 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Indicates whether the transaction is eligible for seller protection. For
+  # information, see [PayPal Seller Protection for
+  # Merchants](https://www.paypal.com/us/webapps/mpp/security/seller-protection)
+  # .
+  class SellerProtectionStatus
+    SELLER_PROTECTION_STATUS = [
+      # TODO: Write general description for ELIGIBLE
+      ELIGIBLE = 'ELIGIBLE'.freeze,
+
+      # TODO: Write general description for PARTIALLY_ELIGIBLE
+      PARTIALLY_ELIGIBLE = 'PARTIALLY_ELIGIBLE'.freeze,
+
+      # TODO: Write general description for NOT_ELIGIBLE
+      NOT_ELIGIBLE = 'NOT_ELIGIBLE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/seller_receivable_breakdown.rb

@@ -0,0 +1,129 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The detailed breakdown of the capture activity. This is not available for
+  # transactions that are in pending state.
+  class SellerReceivableBreakdown < 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 :gross_amount
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :paypal_fee
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :paypal_fee_in_receivable_currency
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :net_amount
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :receivable_amount
+
+    # The exchange rate that determines the amount to convert from one currency
+    # to another currency.
+    # @return [ExchangeRate]
+    attr_accessor :exchange_rate
+
+    # An array of platform or partner fees, commissions, or brokerage fees that
+    # associated with the captured payment.
+    # @return [Array[PlatformFee]]
+    attr_accessor :platform_fees
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['gross_amount'] = 'gross_amount'
+      @_hash['paypal_fee'] = 'paypal_fee'
+      @_hash['paypal_fee_in_receivable_currency'] =
+        'paypal_fee_in_receivable_currency'
+      @_hash['net_amount'] = 'net_amount'
+      @_hash['receivable_amount'] = 'receivable_amount'
+      @_hash['exchange_rate'] = 'exchange_rate'
+      @_hash['platform_fees'] = 'platform_fees'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        paypal_fee
+        paypal_fee_in_receivable_currency
+        net_amount
+        receivable_amount
+        exchange_rate
+        platform_fees
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(gross_amount:, paypal_fee: SKIP,
+                   paypal_fee_in_receivable_currency: SKIP, net_amount: SKIP,
+                   receivable_amount: SKIP, exchange_rate: SKIP,
+                   platform_fees: SKIP)
+      @gross_amount = gross_amount
+      @paypal_fee = paypal_fee unless paypal_fee == SKIP
+      unless paypal_fee_in_receivable_currency == SKIP
+        @paypal_fee_in_receivable_currency =
+          paypal_fee_in_receivable_currency
+      end
+      @net_amount = net_amount unless net_amount == SKIP
+      @receivable_amount = receivable_amount unless receivable_amount == SKIP
+      @exchange_rate = exchange_rate unless exchange_rate == SKIP
+      @platform_fees = platform_fees unless platform_fees == 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.
+      gross_amount = Money.from_hash(hash['gross_amount']) if hash['gross_amount']
+      paypal_fee = Money.from_hash(hash['paypal_fee']) if hash['paypal_fee']
+      if hash['paypal_fee_in_receivable_currency']
+        paypal_fee_in_receivable_currency = Money.from_hash(hash['paypal_fee_in_receivable_currency'])
+      end
+      net_amount = Money.from_hash(hash['net_amount']) if hash['net_amount']
+      receivable_amount = Money.from_hash(hash['receivable_amount']) if hash['receivable_amount']
+      exchange_rate = ExchangeRate.from_hash(hash['exchange_rate']) if hash['exchange_rate']
+      # Parameter is an array, so we need to iterate through it
+      platform_fees = nil
+      unless hash['platform_fees'].nil?
+        platform_fees = []
+        hash['platform_fees'].each do |structure|
+          platform_fees << (PlatformFee.from_hash(structure) if structure)
+        end
+      end
+
+      platform_fees = SKIP unless hash.key?('platform_fees')
+
+      # Create object from extracted values.
+      SellerReceivableBreakdown.new(gross_amount: gross_amount,
+                                    paypal_fee: paypal_fee,
+                                    paypal_fee_in_receivable_currency: paypal_fee_in_receivable_currency,
+                                    net_amount: net_amount,
+                                    receivable_amount: receivable_amount,
+                                    exchange_rate: exchange_rate,
+                                    platform_fees: platform_fees)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/setup_token_card_experience_context.rb

@@ -0,0 +1,103 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Customizes the Vault creation flow experience for your customers.
+  class SetupTokenCardExperienceContext < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The label that overrides the business name in the PayPal account on the
+    # PayPal site. The pattern is defined by an external party and supports
+    # Unicode.
+    # @return [String]
+    attr_accessor :brand_name
+
+    # The [language tag](https://tools.ietf.org/html/bcp47#section-2) for the
+    # language in which to localize the error-related strings, such as messages,
+    # issues, and suggested actions. The tag is made up of the [ISO 639-2
+    # language code](https://www.loc.gov/standards/iso639-2/php/code_list.php),
+    # the optional [ISO-15924 script
+    # tag](https://www.unicode.org/iso15924/codelists.html), and the [ISO-3166
+    # alpha-2 country code](/api/rest/reference/country-codes/) or [M49 region
+    # code](https://unstats.un.org/unsd/methodology/m49/).
+    # @return [String]
+    attr_accessor :locale
+
+    # The URL where the customer is redirected after customer approves leaves
+    # the flow. It is a required field for contingency flows like PayPal wallet,
+    # 3DS.
+    # @return [String]
+    attr_accessor :return_url
+
+    # The URL where the customer is redirected after customer cancels or leaves
+    # the flow. It is a required field for contingency flows like PayPal wallet,
+    # 3DS.
+    # @return [String]
+    attr_accessor :cancel_url
+
+    # Vault Instruction on action to be performed after a successful payer
+    # approval.
+    # @return [String]
+    attr_accessor :vault_instruction
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['brand_name'] = 'brand_name'
+      @_hash['locale'] = 'locale'
+      @_hash['return_url'] = 'return_url'
+      @_hash['cancel_url'] = 'cancel_url'
+      @_hash['vault_instruction'] = 'vault_instruction'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        brand_name
+        locale
+        return_url
+        cancel_url
+        vault_instruction
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(brand_name: SKIP, locale: SKIP, return_url: SKIP,
+                   cancel_url: SKIP,
+                   vault_instruction: 'ON_CREATE_PAYMENT_TOKENS')
+      @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
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      brand_name = hash.key?('brand_name') ? hash['brand_name'] : SKIP
+      locale = hash.key?('locale') ? hash['locale'] : SKIP
+      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'] ||= 'ON_CREATE_PAYMENT_TOKENS'
+
+      # 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)
+    end
+  end
+end