paypal-server-sdk 0.5.0

data/lib/paypal_server_sdk/models/order_authorize_request_payment_source.rb

@@ -0,0 +1,104 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The payment source definition.
+  class OrderAuthorizeRequestPaymentSource < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The payment card to use to fund a payment. Can be a credit or debit
+    # card.<blockquote><strong>Note:</strong> Passing card number, cvv and
+    # expiry directly via the API requires <a
+    # href="https://www.pcisecuritystandards.org/pci_security/completing_self_as
+    # sessment"> PCI SAQ D compliance</a>. <br>*PayPal offers a mechanism by
+    # which you do not have to take on the <strong>PCI SAQ D</strong> burden by
+    # using hosted fields - refer to <a
+    # href="https://developer.paypal.com/docs/checkout/advanced/integrate/">this
+    # Integration Guide</a>*.</blockquote>
+    # @return [CardRequest]
+    attr_accessor :card
+
+    # The tokenized payment source to fund a payment.
+    # @return [Token]
+    attr_accessor :token
+
+    # A resource that identifies a PayPal Wallet is used for payment.
+    # @return [PayPalWallet]
+    attr_accessor :paypal
+
+    # Information needed to pay using ApplePay.
+    # @return [ApplePayRequest]
+    attr_accessor :apple_pay
+
+    # Information needed to pay using Google Pay.
+    # @return [GooglePayRequest]
+    attr_accessor :google_pay
+
+    # Information needed to pay using Venmo.
+    # @return [VenmoWalletRequest]
+    attr_accessor :venmo
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['card'] = 'card'
+      @_hash['token'] = 'token'
+      @_hash['paypal'] = 'paypal'
+      @_hash['apple_pay'] = 'apple_pay'
+      @_hash['google_pay'] = 'google_pay'
+      @_hash['venmo'] = 'venmo'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        card
+        token
+        paypal
+        apple_pay
+        google_pay
+        venmo
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(card: SKIP, token: SKIP, paypal: SKIP, apple_pay: SKIP,
+                   google_pay: SKIP, venmo: SKIP)
+      @card = card unless card == SKIP
+      @token = token unless token == SKIP
+      @paypal = paypal unless paypal == SKIP
+      @apple_pay = apple_pay unless apple_pay == SKIP
+      @google_pay = google_pay unless google_pay == SKIP
+      @venmo = venmo unless venmo == 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.
+      card = CardRequest.from_hash(hash['card']) if hash['card']
+      token = Token.from_hash(hash['token']) if hash['token']
+      paypal = PayPalWallet.from_hash(hash['paypal']) if hash['paypal']
+      apple_pay = ApplePayRequest.from_hash(hash['apple_pay']) if hash['apple_pay']
+      google_pay = GooglePayRequest.from_hash(hash['google_pay']) if hash['google_pay']
+      venmo = VenmoWalletRequest.from_hash(hash['venmo']) if hash['venmo']
+
+      # Create object from extracted values.
+      OrderAuthorizeRequestPaymentSource.new(card: card,
+                                             token: token,
+                                             paypal: paypal,
+                                             apple_pay: apple_pay,
+                                             google_pay: google_pay,
+                                             venmo: venmo)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/order_authorize_response.rb

@@ -0,0 +1,171 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # OrderAuthorizeResponse Model.
+  class OrderAuthorizeResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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.<blockquote><strong>Note:</strong> The regular expression
+    # provides guidance but does not reject all invalid dates.</blockquote>
+    # @return [String]
+    attr_accessor :create_time
+
+    # 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.<blockquote><strong>Note:</strong> The regular expression
+    # provides guidance but does not reject all invalid dates.</blockquote>
+    # @return [String]
+    attr_accessor :update_time
+
+    # The ID of the order.
+    # @return [String]
+    attr_accessor :id
+
+    # The payment source used to fund the payment.
+    # @return [OrderAuthorizeResponsePaymentSource]
+    attr_accessor :payment_source
+
+    # The intent to either capture payment immediately or authorize a payment
+    # for an order after order creation.
+    # @return [CheckoutPaymentIntent]
+    attr_accessor :intent
+
+    # The instruction to process an order.
+    # @return [ProcessingInstruction]
+    attr_accessor :processing_instruction
+
+    # The instruction to process an order.
+    # @return [Payer]
+    attr_accessor :payer
+
+    # An array of purchase units. Each purchase unit establishes a contract
+    # between a customer and merchant. Each purchase unit represents either a
+    # full or partial order that the customer intends to purchase from the
+    # merchant.
+    # @return [Array[PurchaseUnit]]
+    attr_accessor :purchase_units
+
+    # The order status.
+    # @return [OrderStatus]
+    attr_accessor :status
+
+    # An array of request-related [HATEOAS
+    # links](/api/rest/responses/#hateoas-links) that are either relevant to the
+    # issue by providing additional information or offering potential
+    # resolutions.
+    # @return [Array[LinkDescription]]
+    attr_accessor :links
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['create_time'] = 'create_time'
+      @_hash['update_time'] = 'update_time'
+      @_hash['id'] = 'id'
+      @_hash['payment_source'] = 'payment_source'
+      @_hash['intent'] = 'intent'
+      @_hash['processing_instruction'] = 'processing_instruction'
+      @_hash['payer'] = 'payer'
+      @_hash['purchase_units'] = 'purchase_units'
+      @_hash['status'] = 'status'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        create_time
+        update_time
+        id
+        payment_source
+        intent
+        processing_instruction
+        payer
+        purchase_units
+        status
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(
+      create_time: SKIP, update_time: SKIP, id: SKIP, payment_source: SKIP,
+      intent: SKIP,
+      processing_instruction: ProcessingInstruction::NO_INSTRUCTION,
+      payer: SKIP, purchase_units: SKIP, status: SKIP, links: SKIP
+    )
+      @create_time = create_time unless create_time == SKIP
+      @update_time = update_time unless update_time == SKIP
+      @id = id unless id == SKIP
+      @payment_source = payment_source unless payment_source == SKIP
+      @intent = intent unless intent == SKIP
+      @processing_instruction = processing_instruction unless processing_instruction == SKIP
+      @payer = payer unless payer == SKIP
+      @purchase_units = purchase_units unless purchase_units == SKIP
+      @status = status unless status == 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.
+      create_time = hash.key?('create_time') ? hash['create_time'] : SKIP
+      update_time = hash.key?('update_time') ? hash['update_time'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      payment_source = OrderAuthorizeResponsePaymentSource.from_hash(hash['payment_source']) if
+        hash['payment_source']
+      intent = hash.key?('intent') ? hash['intent'] : SKIP
+      processing_instruction =
+        hash['processing_instruction'] ||= ProcessingInstruction::NO_INSTRUCTION
+      payer = Payer.from_hash(hash['payer']) if hash['payer']
+      # Parameter is an array, so we need to iterate through it
+      purchase_units = nil
+      unless hash['purchase_units'].nil?
+        purchase_units = []
+        hash['purchase_units'].each do |structure|
+          purchase_units << (PurchaseUnit.from_hash(structure) if structure)
+        end
+      end
+
+      purchase_units = SKIP unless hash.key?('purchase_units')
+      status = hash.key?('status') ? hash['status'] : 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.
+      OrderAuthorizeResponse.new(create_time: create_time,
+                                 update_time: update_time,
+                                 id: id,
+                                 payment_source: payment_source,
+                                 intent: intent,
+                                 processing_instruction: processing_instruction,
+                                 payer: payer,
+                                 purchase_units: purchase_units,
+                                 status: status,
+                                 links: links)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/order_authorize_response_payment_source.rb

@@ -0,0 +1,88 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The payment source used to fund the payment.
+  class OrderAuthorizeResponsePaymentSource < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The payment card to use to fund a payment. Card can be a credit or debit
+    # card.
+    # @return [CardResponse]
+    attr_accessor :card
+
+    # The PayPal Wallet response.
+    # @return [PayPalWalletResponse]
+    attr_accessor :paypal
+
+    # Information needed to pay using ApplePay.
+    # @return [ApplePayPaymentObject]
+    attr_accessor :apple_pay
+
+    # Google Pay Wallet payment data.
+    # @return [GooglePayWalletResponse]
+    attr_accessor :google_pay
+
+    # Venmo wallet response.
+    # @return [VenmoWalletResponse]
+    attr_accessor :venmo
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['card'] = 'card'
+      @_hash['paypal'] = 'paypal'
+      @_hash['apple_pay'] = 'apple_pay'
+      @_hash['google_pay'] = 'google_pay'
+      @_hash['venmo'] = 'venmo'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        card
+        paypal
+        apple_pay
+        google_pay
+        venmo
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(card: SKIP, paypal: SKIP, apple_pay: SKIP, google_pay: SKIP,
+                   venmo: SKIP)
+      @card = card unless card == SKIP
+      @paypal = paypal unless paypal == SKIP
+      @apple_pay = apple_pay unless apple_pay == SKIP
+      @google_pay = google_pay unless google_pay == SKIP
+      @venmo = venmo unless venmo == 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.
+      card = CardResponse.from_hash(hash['card']) if hash['card']
+      paypal = PayPalWalletResponse.from_hash(hash['paypal']) if hash['paypal']
+      apple_pay = ApplePayPaymentObject.from_hash(hash['apple_pay']) if hash['apple_pay']
+      google_pay = GooglePayWalletResponse.from_hash(hash['google_pay']) if hash['google_pay']
+      venmo = VenmoWalletResponse.from_hash(hash['venmo']) if hash['venmo']
+
+      # Create object from extracted values.
+      OrderAuthorizeResponsePaymentSource.new(card: card,
+                                              paypal: paypal,
+                                              apple_pay: apple_pay,
+                                              google_pay: google_pay,
+                                              venmo: venmo)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/order_capture_request.rb

@@ -0,0 +1,51 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Completes an capture payment for an order.
+  class OrderCaptureRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The payment source definition.
+    # @return [OrderCaptureRequestPaymentSource]
+    attr_accessor :payment_source
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payment_source'] = 'payment_source'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        payment_source
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payment_source: SKIP)
+      @payment_source = payment_source unless payment_source == 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.
+      payment_source = OrderCaptureRequestPaymentSource.from_hash(hash['payment_source']) if
+        hash['payment_source']
+
+      # Create object from extracted values.
+      OrderCaptureRequest.new(payment_source: payment_source)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/order_capture_request_payment_source.rb

@@ -0,0 +1,104 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The payment source definition.
+  class OrderCaptureRequestPaymentSource < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The payment card to use to fund a payment. Can be a credit or debit
+    # card.<blockquote><strong>Note:</strong> Passing card number, cvv and
+    # expiry directly via the API requires <a
+    # href="https://www.pcisecuritystandards.org/pci_security/completing_self_as
+    # sessment"> PCI SAQ D compliance</a>. <br>*PayPal offers a mechanism by
+    # which you do not have to take on the <strong>PCI SAQ D</strong> burden by
+    # using hosted fields - refer to <a
+    # href="https://developer.paypal.com/docs/checkout/advanced/integrate/">this
+    # Integration Guide</a>*.</blockquote>
+    # @return [CardRequest]
+    attr_accessor :card
+
+    # The tokenized payment source to fund a payment.
+    # @return [Token]
+    attr_accessor :token
+
+    # A resource that identifies a PayPal Wallet is used for payment.
+    # @return [PayPalWallet]
+    attr_accessor :paypal
+
+    # Information needed to pay using ApplePay.
+    # @return [ApplePayRequest]
+    attr_accessor :apple_pay
+
+    # Information needed to pay using Google Pay.
+    # @return [GooglePayRequest]
+    attr_accessor :google_pay
+
+    # Information needed to pay using Venmo.
+    # @return [VenmoWalletRequest]
+    attr_accessor :venmo
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['card'] = 'card'
+      @_hash['token'] = 'token'
+      @_hash['paypal'] = 'paypal'
+      @_hash['apple_pay'] = 'apple_pay'
+      @_hash['google_pay'] = 'google_pay'
+      @_hash['venmo'] = 'venmo'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        card
+        token
+        paypal
+        apple_pay
+        google_pay
+        venmo
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(card: SKIP, token: SKIP, paypal: SKIP, apple_pay: SKIP,
+                   google_pay: SKIP, venmo: SKIP)
+      @card = card unless card == SKIP
+      @token = token unless token == SKIP
+      @paypal = paypal unless paypal == SKIP
+      @apple_pay = apple_pay unless apple_pay == SKIP
+      @google_pay = google_pay unless google_pay == SKIP
+      @venmo = venmo unless venmo == 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.
+      card = CardRequest.from_hash(hash['card']) if hash['card']
+      token = Token.from_hash(hash['token']) if hash['token']
+      paypal = PayPalWallet.from_hash(hash['paypal']) if hash['paypal']
+      apple_pay = ApplePayRequest.from_hash(hash['apple_pay']) if hash['apple_pay']
+      google_pay = GooglePayRequest.from_hash(hash['google_pay']) if hash['google_pay']
+      venmo = VenmoWalletRequest.from_hash(hash['venmo']) if hash['venmo']
+
+      # Create object from extracted values.
+      OrderCaptureRequestPaymentSource.new(card: card,
+                                           token: token,
+                                           paypal: paypal,
+                                           apple_pay: apple_pay,
+                                           google_pay: google_pay,
+                                           venmo: venmo)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/order_confirm_application_context.rb

@@ -0,0 +1,109 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Customizes the payer confirmation experience.
+  class OrderConfirmApplicationContext < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Label to present to your payer as part of the PayPal hosted web
+    # experience.
+    # @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 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
+
+    # Provides additional details to process a payment using a `payment_source`
+    # that has been stored or is intended to be stored (also referred to as
+    # stored_credential or card-on-file).<br/>Parameter
+    # compatibility:<br/><ul><li>`payment_type=ONE_TIME` is compatible only with
+    # `payment_initiator=CUSTOMER`.</li><li>`usage=FIRST` is compatible only
+    # with
+    # `payment_initiator=CUSTOMER`.</li><li>`previous_transaction_reference` or
+    # `previous_network_transaction_reference` is compatible only with
+    # `payment_initiator=MERCHANT`.</li><li>Only one of the parameters -
+    # `previous_transaction_reference` and
+    # `previous_network_transaction_reference` - can be present in the
+    # request.</li></ul>
+    # @return [StoredPaymentSource]
+    attr_accessor :stored_payment_source
+
+    # 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['stored_payment_source'] = 'stored_payment_source'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        brand_name
+        locale
+        return_url
+        cancel_url
+        stored_payment_source
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(brand_name: SKIP, locale: SKIP, return_url: SKIP,
+                   cancel_url: SKIP, stored_payment_source: SKIP)
+      @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
+      @stored_payment_source = stored_payment_source unless stored_payment_source == 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
+      stored_payment_source = StoredPaymentSource.from_hash(hash['stored_payment_source']) if
+        hash['stored_payment_source']
+
+      # Create object from extracted values.
+      OrderConfirmApplicationContext.new(brand_name: brand_name,
+                                         locale: locale,
+                                         return_url: return_url,
+                                         cancel_url: cancel_url,
+                                         stored_payment_source: stored_payment_source)
+    end
+  end
+end