paypal-server-sdk 0.5.0

data/lib/paypal_server_sdk/models/o_auth_token.rb

@@ -0,0 +1,106 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # OAuth 2 Authorization endpoint response
+  class OAuthToken < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Access token
+    # @return [String]
+    attr_accessor :access_token
+
+    # Type of access token
+    # @return [String]
+    attr_accessor :token_type
+
+    # Time in seconds before the access token expires
+    # @return [Integer]
+    attr_accessor :expires_in
+
+    # List of scopes granted
+    # This is a space-delimited list of strings.
+    # @return [String]
+    attr_accessor :scope
+
+    # Time of token expiry as unix timestamp (UTC)
+    # @return [Integer]
+    attr_accessor :expiry
+
+    # Refresh token
+    # Used to get a new access token when it expires.
+    # @return [String]
+    attr_accessor :refresh_token
+
+    # An ID token response type is of JSON Web Token (JWT) that contains claims
+    # about the identity of the authenticated user.
+    # @return [String]
+    attr_accessor :id_token
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['access_token'] = 'access_token'
+      @_hash['token_type'] = 'token_type'
+      @_hash['expires_in'] = 'expires_in'
+      @_hash['scope'] = 'scope'
+      @_hash['expiry'] = 'expiry'
+      @_hash['refresh_token'] = 'refresh_token'
+      @_hash['id_token'] = 'id_token'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        expires_in
+        scope
+        expiry
+        refresh_token
+        id_token
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(access_token:, token_type:, expires_in: SKIP, scope: SKIP,
+                   expiry: SKIP, refresh_token: SKIP, id_token: SKIP)
+      @access_token = access_token
+      @token_type = token_type
+      @expires_in = expires_in unless expires_in == SKIP
+      @scope = scope unless scope == SKIP
+      @expiry = expiry unless expiry == SKIP
+      @refresh_token = refresh_token unless refresh_token == SKIP
+      @id_token = id_token unless id_token == 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.
+      access_token = hash.key?('access_token') ? hash['access_token'] : nil
+      token_type = hash.key?('token_type') ? hash['token_type'] : nil
+      expires_in = hash.key?('expires_in') ? hash['expires_in'] : SKIP
+      scope = hash.key?('scope') ? hash['scope'] : SKIP
+      expiry = hash.key?('expiry') ? hash['expiry'] : SKIP
+      refresh_token = hash.key?('refresh_token') ? hash['refresh_token'] : SKIP
+      id_token = hash.key?('id_token') ? hash['id_token'] : SKIP
+
+      # Create object from extracted values.
+      OAuthToken.new(access_token: access_token,
+                     token_type: token_type,
+                     expires_in: expires_in,
+                     scope: scope,
+                     expiry: expiry,
+                     refresh_token: refresh_token,
+                     id_token: id_token)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/order.rb

@@ -0,0 +1,178 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The order details.
+  class Order < 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 [PaymentSourceResponse]
+    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. To complete payer approval, use
+    # the `approve` link to redirect the payer. The API caller has 3 hours
+    # (default setting, this which can be changed by your account manager to
+    # 24/48/72 hours to accommodate your use case) from the time the order is
+    # created, to redirect your payer. Once redirected, the API caller has 3
+    # hours for the payer to approve the order and either authorize or capture
+    # the order. If you are not using the PayPal JavaScript SDK to initiate
+    # PayPal Checkout (in context) ensure that you include
+    # `application_context.return_url` is specified or you will get "We're
+    # sorry, Things don't appear to be working at the moment" after the payer
+    # approves the payment.
+    # @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 = PaymentSourceResponse.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.
+      Order.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_application_context.rb

@@ -0,0 +1,193 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Customizes the payer experience during the approval process for the payment
+  # with PayPal.<blockquote><strong>Note:</strong> Partners and Marketplaces
+  # might configure <code>brand_name</code> and <code>shipping_preference</code>
+  # during partner account setup, which overrides the request
+  # values.</blockquote>
+  class OrderApplicationContext < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # DEPRECATED. The label that overrides the business name in the PayPal
+    # account on the PayPal site. The fields in `application_context` are now
+    # available in the `experience_context` object under the `payment_source`
+    # which supports them (eg.
+    # `payment_source.paypal.experience_context.brand_name`). Please specify
+    # this field in the `experience_context` object instead of the
+    # `application_context` object.
+    # @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
+
+    # DEPRECATED. DEPRECATED. The type of landing page to show on the PayPal
+    # site for customer checkout.  The fields in `application_context` are now
+    # available in the `experience_context` object under the `payment_source`
+    # which supports them (eg.
+    # `payment_source.paypal.experience_context.landing_page`). Please specify
+    # this field in the `experience_context` object instead of the
+    # `application_context` object.
+    # @return [OrderApplicationContextLandingPage]
+    attr_accessor :landing_page
+
+    # DEPRECATED. DEPRECATED. The shipping preference:<ul><li>Displays the
+    # shipping address to the customer.</li><li>Enables the customer to choose
+    # an address on the PayPal site.</li><li>Restricts the customer from
+    # changing the address during the payment-approval process.</li></ul>.  The
+    # fields in `application_context` are now available in the
+    # `experience_context` object under the `payment_source` which supports them
+    # (eg. `payment_source.paypal.experience_context.shipping_preference`).
+    # Please specify this field in the `experience_context` object instead of
+    # the `application_context` object.
+    # @return [OrderApplicationContextShippingPreference]
+    attr_accessor :shipping_preference
+
+    # DEPRECATED. Configures a <strong>Continue</strong> or <strong>Pay
+    # Now</strong> checkout flow.  The fields in `application_context` are now
+    # available in the `experience_context` object under the `payment_source`
+    # which supports them (eg.
+    # `payment_source.paypal.experience_context.user_action`). Please specify
+    # this field in the `experience_context` object instead of the
+    # `application_context` object.
+    # @return [OrderApplicationContextUserAction]
+    attr_accessor :user_action
+
+    # The customer and merchant payment preferences.
+    # @return [PaymentMethodPreference]
+    attr_accessor :payment_method
+
+    # DEPRECATED. The URL where the customer is redirected after the customer
+    # approves the payment. The fields in `application_context` are now
+    # available in the `experience_context` object under the `payment_source`
+    # which supports them (eg.
+    # `payment_source.paypal.experience_context.return_url`). Please specify
+    # this field in the `experience_context` object instead of the
+    # `application_context` object.
+    # @return [String]
+    attr_accessor :return_url
+
+    # DEPRECATED. The URL where the customer is redirected after the customer
+    # cancels the payment. The fields in `application_context` are now available
+    # in the `experience_context` object under the `payment_source` which
+    # supports them (eg. `payment_source.paypal.experience_context.cancel_url`).
+    # Please specify this field in the `experience_context` object instead of
+    # the `application_context` object.
+    # @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['landing_page'] = 'landing_page'
+      @_hash['shipping_preference'] = 'shipping_preference'
+      @_hash['user_action'] = 'user_action'
+      @_hash['payment_method'] = 'payment_method'
+      @_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
+        landing_page
+        shipping_preference
+        user_action
+        payment_method
+        return_url
+        cancel_url
+        stored_payment_source
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(
+      brand_name: SKIP, locale: SKIP,
+      landing_page: OrderApplicationContextLandingPage::NO_PREFERENCE,
+      shipping_preference: OrderApplicationContextShippingPreference::GET_FROM_FILE,
+      user_action: OrderApplicationContextUserAction::CONTINUE,
+      payment_method: SKIP, return_url: SKIP, cancel_url: SKIP,
+      stored_payment_source: SKIP
+    )
+      @brand_name = brand_name unless brand_name == SKIP
+      @locale = locale unless locale == SKIP
+      @landing_page = landing_page unless landing_page == SKIP
+      @shipping_preference = shipping_preference unless shipping_preference == SKIP
+      @user_action = user_action unless user_action == SKIP
+      @payment_method = payment_method unless payment_method == 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
+      landing_page =
+        hash['landing_page'] ||= OrderApplicationContextLandingPage::NO_PREFERENCE
+      shipping_preference =
+        hash['shipping_preference'] ||= OrderApplicationContextShippingPreference::GET_FROM_FILE
+      user_action =
+        hash['user_action'] ||= OrderApplicationContextUserAction::CONTINUE
+      payment_method = PaymentMethodPreference.from_hash(hash['payment_method']) if
+        hash['payment_method']
+      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.
+      OrderApplicationContext.new(brand_name: brand_name,
+                                  locale: locale,
+                                  landing_page: landing_page,
+                                  shipping_preference: shipping_preference,
+                                  user_action: user_action,
+                                  payment_method: payment_method,
+                                  return_url: return_url,
+                                  cancel_url: cancel_url,
+                                  stored_payment_source: stored_payment_source)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/order_application_context_landing_page.rb

@@ -0,0 +1,32 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # DEPRECATED. DEPRECATED. The type of landing page to show on the PayPal site
+  # for customer checkout.  The fields in `application_context` are now
+  # available in the `experience_context` object under the `payment_source`
+  # which supports them (eg.
+  # `payment_source.paypal.experience_context.landing_page`). Please specify
+  # this field in the `experience_context` object instead of the
+  # `application_context` object.
+  class OrderApplicationContextLandingPage
+    ORDER_APPLICATION_CONTEXT_LANDING_PAGE = [
+      # TODO: Write general description for LOGIN
+      LOGIN = 'LOGIN'.freeze,
+
+      # TODO: Write general description for BILLING
+      BILLING = 'BILLING'.freeze,
+
+      # TODO: Write general description for NO_PREFERENCE
+      NO_PREFERENCE = 'NO_PREFERENCE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/order_application_context_shipping_preference.rb

@@ -0,0 +1,34 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # DEPRECATED. DEPRECATED. The shipping preference:<ul><li>Displays the
+  # shipping address to the customer.</li><li>Enables the customer to choose an
+  # address on the PayPal site.</li><li>Restricts the customer from changing the
+  # address during the payment-approval process.</li></ul>.  The fields in
+  # `application_context` are now available in the `experience_context` object
+  # under the `payment_source` which supports them (eg.
+  # `payment_source.paypal.experience_context.shipping_preference`). Please
+  # specify this field in the `experience_context` object instead of the
+  # `application_context` object.
+  class OrderApplicationContextShippingPreference
+    ORDER_APPLICATION_CONTEXT_SHIPPING_PREFERENCE = [
+      # TODO: Write general description for GET_FROM_FILE
+      GET_FROM_FILE = 'GET_FROM_FILE'.freeze,
+
+      # TODO: Write general description for NO_SHIPPING
+      NO_SHIPPING = 'NO_SHIPPING'.freeze,
+
+      # TODO: Write general description for SET_PROVIDED_ADDRESS
+      SET_PROVIDED_ADDRESS = 'SET_PROVIDED_ADDRESS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/order_application_context_user_action.rb

@@ -0,0 +1,29 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # DEPRECATED. Configures a <strong>Continue</strong> or <strong>Pay
+  # Now</strong> checkout flow.  The fields in `application_context` are now
+  # available in the `experience_context` object under the `payment_source`
+  # which supports them (eg.
+  # `payment_source.paypal.experience_context.user_action`). Please specify this
+  # field in the `experience_context` object instead of the
+  # `application_context` object.
+  class OrderApplicationContextUserAction
+    ORDER_APPLICATION_CONTEXT_USER_ACTION = [
+      # TODO: Write general description for CONTINUE
+      CONTINUE = 'CONTINUE'.freeze,
+
+      # TODO: Write general description for PAY_NOW
+      PAY_NOW = 'PAY_NOW'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/order_authorize_request.rb

@@ -0,0 +1,51 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The authorization of an order request.
+  class OrderAuthorizeRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The payment source definition.
+    # @return [OrderAuthorizeRequestPaymentSource]
+    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 = OrderAuthorizeRequestPaymentSource.from_hash(hash['payment_source']) if
+        hash['payment_source']
+
+      # Create object from extracted values.
+      OrderAuthorizeRequest.new(payment_source: payment_source)
+    end
+  end
+end