paypal-server-sdk 0.5.0

data/lib/paypal_server_sdk/models/order_request.rb

@@ -0,0 +1,103 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The order request details.
+  class OrderRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The intent to either capture payment immediately or authorize a payment
+    # for an order after order creation.
+    # @return [CheckoutPaymentIntent]
+    attr_accessor :intent
+
+    # The intent to either capture payment immediately or authorize a payment
+    # for an order after order creation.
+    # @return [Payer]
+    attr_accessor :payer
+
+    # An array of purchase units. Each purchase unit establishes a contract
+    # between a payer and the payee. Each purchase unit represents either a full
+    # or partial order that the payer intends to purchase from the payee.
+    # @return [Array[PurchaseUnitRequest]]
+    attr_accessor :purchase_units
+
+    # The payment source definition.
+    # @return [PaymentSource]
+    attr_accessor :payment_source
+
+    # 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>
+    # @return [OrderApplicationContext]
+    attr_accessor :application_context
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['intent'] = 'intent'
+      @_hash['payer'] = 'payer'
+      @_hash['purchase_units'] = 'purchase_units'
+      @_hash['payment_source'] = 'payment_source'
+      @_hash['application_context'] = 'application_context'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        payer
+        payment_source
+        application_context
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(intent:, purchase_units:, payer: SKIP, payment_source: SKIP,
+                   application_context: SKIP)
+      @intent = intent
+      @payer = payer unless payer == SKIP
+      @purchase_units = purchase_units
+      @payment_source = payment_source unless payment_source == SKIP
+      @application_context = application_context unless application_context == 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.
+      intent = hash.key?('intent') ? hash['intent'] : nil
+      # 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 << (PurchaseUnitRequest.from_hash(structure) if structure)
+        end
+      end
+
+      purchase_units = nil unless hash.key?('purchase_units')
+      payer = Payer.from_hash(hash['payer']) if hash['payer']
+      payment_source = PaymentSource.from_hash(hash['payment_source']) if hash['payment_source']
+      application_context = OrderApplicationContext.from_hash(hash['application_context']) if
+        hash['application_context']
+
+      # Create object from extracted values.
+      OrderRequest.new(intent: intent,
+                       purchase_units: purchase_units,
+                       payer: payer,
+                       payment_source: payment_source,
+                       application_context: application_context)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/order_status.rb

@@ -0,0 +1,35 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The order status.
+  class OrderStatus
+    ORDER_STATUS = [
+      # TODO: Write general description for CREATED
+      CREATED = 'CREATED'.freeze,
+
+      # TODO: Write general description for SAVED
+      SAVED = 'SAVED'.freeze,
+
+      # TODO: Write general description for APPROVED
+      APPROVED = 'APPROVED'.freeze,
+
+      # TODO: Write general description for VOIDED
+      VOIDED = 'VOIDED'.freeze,
+
+      # TODO: Write general description for COMPLETED
+      COMPLETED = 'COMPLETED'.freeze,
+
+      # TODO: Write general description for PAYER_ACTION_REQUIRED
+      PAYER_ACTION_REQUIRED = 'PAYER_ACTION_REQUIRED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/order_tracker_item.rb

@@ -0,0 +1,99 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The details of the items in the shipment.
+  class OrderTrackerItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The item name or title.
+    # @return [String]
+    attr_accessor :name
+
+    # The item quantity. Must be a whole number.
+    # @return [String]
+    attr_accessor :quantity
+
+    # The stock keeping unit (SKU) for the item. This can contain unicode
+    # characters.
+    # @return [String]
+    attr_accessor :sku
+
+    # The URL to the item being purchased. Visible to buyer and used in buyer
+    # experiences.
+    # @return [String]
+    attr_accessor :url
+
+    # The URL of the item's image. File type and size restrictions apply. An
+    # image that violates these restrictions will not be honored.
+    # @return [String]
+    attr_accessor :image_url
+
+    # The Universal Product Code of the item.
+    # @return [UniversalProductCode]
+    attr_accessor :upc
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['quantity'] = 'quantity'
+      @_hash['sku'] = 'sku'
+      @_hash['url'] = 'url'
+      @_hash['image_url'] = 'image_url'
+      @_hash['upc'] = 'upc'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        quantity
+        sku
+        url
+        image_url
+        upc
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, quantity: SKIP, sku: SKIP, url: SKIP,
+                   image_url: SKIP, upc: SKIP)
+      @name = name unless name == SKIP
+      @quantity = quantity unless quantity == SKIP
+      @sku = sku unless sku == SKIP
+      @url = url unless url == SKIP
+      @image_url = image_url unless image_url == SKIP
+      @upc = upc unless upc == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      quantity = hash.key?('quantity') ? hash['quantity'] : SKIP
+      sku = hash.key?('sku') ? hash['sku'] : SKIP
+      url = hash.key?('url') ? hash['url'] : SKIP
+      image_url = hash.key?('image_url') ? hash['image_url'] : SKIP
+      upc = UniversalProductCode.from_hash(hash['upc']) if hash['upc']
+
+      # Create object from extracted values.
+      OrderTrackerItem.new(name: name,
+                           quantity: quantity,
+                           sku: sku,
+                           url: url,
+                           image_url: image_url,
+                           upc: upc)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/order_tracker_request.rb

@@ -0,0 +1,116 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The tracking details of an order.
+  class OrderTrackerRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The tracking number for the shipment. This property supports Unicode.
+    # @return [String]
+    attr_accessor :tracking_number
+
+    # The carrier for the shipment. Some carriers have a global version as well
+    # as local subsidiaries. The subsidiaries are repeated over many countries
+    # and might also have an entry in the global list. Choose the carrier for
+    # your country. If the carrier is not available for your country, choose the
+    # global version of the carrier. If your carrier name is not in the list,
+    # set `carrier` to `OTHER` and set carrier name in `carrier_name_other`. For
+    # allowed values, see <a
+    # href="/docs/tracking/reference/carriers/">Carriers</a>.
+    # @return [ShipmentCarrier]
+    attr_accessor :carrier
+
+    # The name of the carrier for the shipment. Provide this value only if the
+    # carrier parameter is OTHER. This property supports Unicode.
+    # @return [String]
+    attr_accessor :carrier_name_other
+
+    # The PayPal capture ID.
+    # @return [String]
+    attr_accessor :capture_id
+
+    # If true, sends an email notification to the payer of the PayPal
+    # transaction. The email contains the tracking information that was uploaded
+    # through the API.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :notify_payer
+
+    # An array of details of items in the shipment.
+    # @return [Array[OrderTrackerItem]]
+    attr_accessor :items
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tracking_number'] = 'tracking_number'
+      @_hash['carrier'] = 'carrier'
+      @_hash['carrier_name_other'] = 'carrier_name_other'
+      @_hash['capture_id'] = 'capture_id'
+      @_hash['notify_payer'] = 'notify_payer'
+      @_hash['items'] = 'items'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tracking_number
+        carrier
+        carrier_name_other
+        notify_payer
+        items
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(capture_id:, tracking_number: SKIP, carrier: SKIP,
+                   carrier_name_other: SKIP, notify_payer: false, items: SKIP)
+      @tracking_number = tracking_number unless tracking_number == SKIP
+      @carrier = carrier unless carrier == SKIP
+      @carrier_name_other = carrier_name_other unless carrier_name_other == SKIP
+      @capture_id = capture_id
+      @notify_payer = notify_payer unless notify_payer == SKIP
+      @items = items unless items == 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.
+      capture_id = hash.key?('capture_id') ? hash['capture_id'] : nil
+      tracking_number =
+        hash.key?('tracking_number') ? hash['tracking_number'] : SKIP
+      carrier = hash.key?('carrier') ? hash['carrier'] : SKIP
+      carrier_name_other =
+        hash.key?('carrier_name_other') ? hash['carrier_name_other'] : SKIP
+      notify_payer = hash['notify_payer'] ||= false
+      # Parameter is an array, so we need to iterate through it
+      items = nil
+      unless hash['items'].nil?
+        items = []
+        hash['items'].each do |structure|
+          items << (OrderTrackerItem.from_hash(structure) if structure)
+        end
+      end
+
+      items = SKIP unless hash.key?('items')
+
+      # Create object from extracted values.
+      OrderTrackerRequest.new(capture_id: capture_id,
+                              tracking_number: tracking_number,
+                              carrier: carrier,
+                              carrier_name_other: carrier_name_other,
+                              notify_payer: notify_payer,
+                              items: items)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/order_tracker_response.rb

@@ -0,0 +1,122 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The tracking response on creation of tracker.
+  class OrderTrackerResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The tracker id.
+    # @return [String]
+    attr_accessor :id
+
+    # The status of the item shipment.
+    # @return [OrderTrackerStatus]
+    attr_accessor :status
+
+    # An array of details of items in the shipment.
+    # @return [Array[OrderTrackerItem]]
+    attr_accessor :items
+
+    # An array of request-related HATEOAS links.
+    # @return [Array[LinkDescription]]
+    attr_accessor :links
+
+    # 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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['status'] = 'status'
+      @_hash['items'] = 'items'
+      @_hash['links'] = 'links'
+      @_hash['create_time'] = 'create_time'
+      @_hash['update_time'] = 'update_time'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        status
+        items
+        links
+        create_time
+        update_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, status: SKIP, items: SKIP, links: SKIP,
+                   create_time: SKIP, update_time: SKIP)
+      @id = id unless id == SKIP
+      @status = status unless status == SKIP
+      @items = items unless items == SKIP
+      @links = links unless links == SKIP
+      @create_time = create_time unless create_time == SKIP
+      @update_time = update_time unless update_time == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      items = nil
+      unless hash['items'].nil?
+        items = []
+        hash['items'].each do |structure|
+          items << (OrderTrackerItem.from_hash(structure) if structure)
+        end
+      end
+
+      items = SKIP unless hash.key?('items')
+      # 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_time = hash.key?('create_time') ? hash['create_time'] : SKIP
+      update_time = hash.key?('update_time') ? hash['update_time'] : SKIP
+
+      # Create object from extracted values.
+      OrderTrackerResponse.new(id: id,
+                               status: status,
+                               items: items,
+                               links: links,
+                               create_time: create_time,
+                               update_time: update_time)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/order_tracker_status.rb

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

data/lib/paypal_server_sdk/models/p24_payment_object.rb

@@ -0,0 +1,108 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Information used to pay using P24(Przelewy24).
+  class P24PaymentObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The full name representation like Mr J Smith.
+    # @return [String]
+    attr_accessor :name
+
+    # The internationalized email address.<blockquote><strong>Note:</strong> Up
+    # to 64 characters are allowed before and 255 characters are allowed after
+    # the <code>@</code> sign. However, the generally accepted maximum length
+    # for an email address is 254 characters. The pattern verifies that an
+    # unquoted <code>@</code> sign exists.</blockquote>
+    # @return [String]
+    attr_accessor :email
+
+    # The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/)
+    # that identifies the country or region.<blockquote><strong>Note:</strong>
+    # The country code for Great Britain is <code>GB</code> and not
+    # <code>UK</code> as used in the top-level domain names for that country.
+    # Use the `C2` country code for China worldwide for comparable uncontrolled
+    # price (CUP) method, bank card, and cross-border transactions.</blockquote>
+    # @return [String]
+    attr_accessor :country_code
+
+    # P24 generated payment description.
+    # @return [String]
+    attr_accessor :payment_descriptor
+
+    # Numeric identifier of the payment scheme or bank used for the payment.
+    # @return [String]
+    attr_accessor :method_id
+
+    # Friendly name of the payment scheme or bank used for the payment.
+    # @return [String]
+    attr_accessor :method_description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['email'] = 'email'
+      @_hash['country_code'] = 'country_code'
+      @_hash['payment_descriptor'] = 'payment_descriptor'
+      @_hash['method_id'] = 'method_id'
+      @_hash['method_description'] = 'method_description'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        email
+        country_code
+        payment_descriptor
+        method_id
+        method_description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, email: SKIP, country_code: SKIP,
+                   payment_descriptor: SKIP, method_id: SKIP,
+                   method_description: SKIP)
+      @name = name unless name == SKIP
+      @email = email unless email == SKIP
+      @country_code = country_code unless country_code == SKIP
+      @payment_descriptor = payment_descriptor unless payment_descriptor == SKIP
+      @method_id = method_id unless method_id == SKIP
+      @method_description = method_description unless method_description == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+      country_code = hash.key?('country_code') ? hash['country_code'] : SKIP
+      payment_descriptor =
+        hash.key?('payment_descriptor') ? hash['payment_descriptor'] : SKIP
+      method_id = hash.key?('method_id') ? hash['method_id'] : SKIP
+      method_description =
+        hash.key?('method_description') ? hash['method_description'] : SKIP
+
+      # Create object from extracted values.
+      P24PaymentObject.new(name: name,
+                           email: email,
+                           country_code: country_code,
+                           payment_descriptor: payment_descriptor,
+                           method_id: method_id,
+                           method_description: method_description)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/p24_payment_request.rb

@@ -0,0 +1,85 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Information needed to pay using P24 (Przelewy24).
+  class P24PaymentRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The full name representation like Mr J Smith.
+    # @return [String]
+    attr_accessor :name
+
+    # The internationalized email address.<blockquote><strong>Note:</strong> Up
+    # to 64 characters are allowed before and 255 characters are allowed after
+    # the <code>@</code> sign. However, the generally accepted maximum length
+    # for an email address is 254 characters. The pattern verifies that an
+    # unquoted <code>@</code> sign exists.</blockquote>
+    # @return [String]
+    attr_accessor :email
+
+    # The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/)
+    # that identifies the country or region.<blockquote><strong>Note:</strong>
+    # The country code for Great Britain is <code>GB</code> and not
+    # <code>UK</code> as used in the top-level domain names for that country.
+    # Use the `C2` country code for China worldwide for comparable uncontrolled
+    # price (CUP) method, bank card, and cross-border transactions.</blockquote>
+    # @return [String]
+    attr_accessor :country_code
+
+    # Customizes the payer experience during the approval process for the
+    # payment.
+    # @return [ExperienceContext]
+    attr_accessor :experience_context
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['email'] = 'email'
+      @_hash['country_code'] = 'country_code'
+      @_hash['experience_context'] = 'experience_context'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        experience_context
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name:, email:, country_code:, experience_context: SKIP)
+      @name = name
+      @email = email
+      @country_code = country_code
+      @experience_context = experience_context unless experience_context == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      name = hash.key?('name') ? hash['name'] : nil
+      email = hash.key?('email') ? hash['email'] : nil
+      country_code = hash.key?('country_code') ? hash['country_code'] : nil
+      experience_context = ExperienceContext.from_hash(hash['experience_context']) if
+        hash['experience_context']
+
+      # Create object from extracted values.
+      P24PaymentRequest.new(name: name,
+                            email: email,
+                            country_code: country_code,
+                            experience_context: experience_context)
+    end
+  end
+end