paypal-server-sdk 1.0.0 → 2.0.0

data/lib/paypal_server_sdk/models/shipment_carrier.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # The carrier for the shipment. Some carriers have a global version as well as
@@ -4139,7 +4139,115 @@ module PaypalServerSdk
       WINESHIPPING = 'WINESHIPPING'.freeze,
 
       # Spedisci online.
-      SPEDISCI = 'SPEDISCI'.freeze
+      SPEDISCI = 'SPEDISCI'.freeze,
+
+      # Fourkites.
+      FOURKITES = 'FOURKITES'.freeze,
+
+      # Etonas.
+      ETONAS = 'ETONAS'.freeze,
+
+      # Fin Mile.
+      FINMILE = 'FINMILE'.freeze,
+
+      # Uniuni.
+      UNIUNI = 'UNIUNI'.freeze,
+
+      # Rodonaves.
+      RODONAVES = 'RODONAVES'.freeze,
+
+      # Inpost Italy.
+      INPOST_IT = 'INPOST_IT'.freeze,
+
+      # Tforce Freight.
+      TFORCE_FREIGHT = 'TFORCE_FREIGHT'.freeze,
+
+      # Rich Mom.
+      RICHMOM = 'RICHMOM'.freeze,
+
+      # Corriere Franco.
+      FRANCO = 'FRANCO'.freeze,
+
+      # Ecparcel.
+      ECPARCEL = 'ECPARCEL'.freeze,
+
+      # Fedex China.
+      FEDEX_CHINA = 'FEDEX_CHINA'.freeze,
+
+      # Gofo Express.
+      GOFO_EXPRESS = 'GOFO_EXPRESS'.freeze,
+
+      # Shipbob.
+      SHIPBOB = 'SHIPBOB'.freeze,
+
+      # Jersey Post Group.
+      JERSEYPOST_ATLAS = 'JERSEYPOST_ATLAS'.freeze,
+
+      # Coretrails.
+      CORETRAILS = 'CORETRAILS'.freeze,
+
+      # Rhenus Logistics Italy.
+      RHENUS_ITALY = 'RHENUS_ITALY'.freeze,
+
+      # Jadlog.
+      JADLOG = 'JADLOG'.freeze,
+
+      # Jitsu.
+      JITSU = 'JITSU'.freeze,
+
+      # Yanwen Express.
+      YANWEN_EXPRESS = 'YANWEN_EXPRESS'.freeze,
+
+      # Dashlink.
+      DASHLINK = 'DASHLINK'.freeze,
+
+      # Seino Super Express.
+      SEINO_SUPER_EXPRESS = 'SEINO_SUPER_EXPRESS'.freeze,
+
+      # Floship.
+      FLOSHIP = 'FLOSHIP'.freeze,
+
+      # Metro Supply Chain.
+      METROSCG = 'METROSCG'.freeze,
+
+      # Sendparcel.
+      SENDPARCEL = 'SENDPARCEL'.freeze,
+
+      # P2p.
+      P2P = 'P2P'.freeze,
+
+      # Cn Express.
+      CN_EXPRESS = 'CN_EXPRESS'.freeze,
+
+      # Cirro Track.
+      CIRROTRACK = 'CIRROTRACK'.freeze,
+
+      # Land Logistics.
+      LAND_LOGISTICS = 'LAND_LOGISTICS'.freeze,
+
+      # Veho.
+      VEHO = 'VEHO'.freeze,
+
+      # Medline.
+      MEDLINE = 'MEDLINE'.freeze,
+
+      # Vdtrack.
+      VDTRACK = 'VDTRACK'.freeze,
+
+      # Sino Scm.
+      SINO_SCM = 'SINO_SCM'.freeze,
+
+      # 3pe Express.
+      ENUM_3PE_EXPRESS = '3PE_EXPRESS'.freeze,
+
+      # Swiftx.
+      SWIFTX = 'SWIFTX'.freeze,
+
+      # Sfyd Express.
+      SFYDEXPRESS = 'SFYDEXPRESS'.freeze,
+
+      # Toptrans.
+      TOPTRANS = 'TOPTRANS'.freeze
     ].freeze
 
     def self.validate(value)

data/lib/paypal_server_sdk/models/shipping_details.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # The shipping details.

data/lib/paypal_server_sdk/models/shipping_information.rb

@@ -0,0 +1,101 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The shipping information.
+  class ShippingInformation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The recipient's name.
+    # @return [String]
+    attr_accessor :name
+
+    # The shipping method that is associated with this order.
+    # @return [String]
+    attr_accessor :method
+
+    # A simple postal address with coarse-grained fields. Do not use for an
+    # international address. Use for backward compatibility only. Does not
+    # contain phone.
+    # @return [SimplePostalAddressCoarseGrained]
+    attr_accessor :address
+
+    # A simple postal address with coarse-grained fields. Do not use for an
+    # international address. Use for backward compatibility only. Does not
+    # contain phone.
+    # @return [SimplePostalAddressCoarseGrained]
+    attr_accessor :secondary_shipping_address
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['method'] = 'method'
+      @_hash['address'] = 'address'
+      @_hash['secondary_shipping_address'] = 'secondary_shipping_address'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        method
+        address
+        secondary_shipping_address
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, method: SKIP, address: SKIP,
+                   secondary_shipping_address: SKIP)
+      @name = name unless name == SKIP
+      @method = method unless method == SKIP
+      @address = address unless address == SKIP
+      unless secondary_shipping_address == SKIP
+        @secondary_shipping_address =
+          secondary_shipping_address
+      end
+    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
+      method = hash.key?('method') ? hash['method'] : SKIP
+      address = SimplePostalAddressCoarseGrained.from_hash(hash['address']) if hash['address']
+      if hash['secondary_shipping_address']
+        secondary_shipping_address = SimplePostalAddressCoarseGrained.from_hash(hash['secondary_shipping_address'])
+      end
+
+      # Create object from extracted values.
+      ShippingInformation.new(name: name,
+                              method: method,
+                              address: address,
+                              secondary_shipping_address: secondary_shipping_address)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, method: #{@method}, address: #{@address},"\
+      " secondary_shipping_address: #{@secondary_shipping_address}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, method: #{@method.inspect}, address:"\
+      " #{@address.inspect}, secondary_shipping_address: #{@secondary_shipping_address.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/shipping_name.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # The name of the party.

data/lib/paypal_server_sdk/models/shipping_option.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # The options that the payee or merchant offers to the payer to ship or pick

data/lib/paypal_server_sdk/models/shipping_type.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # A classification for the method of purchase fulfillment.

data/lib/paypal_server_sdk/models/shipping_with_tracking_details.rb

@@ -1,14 +1,18 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
-  # The order shipping details.
+  # ShippingWithTrackingDetails Model.
   class ShippingWithTrackingDetails < BaseModel
     SKIP = Object.new
     private_constant :SKIP
 
+    # An array of trackers for a transaction.
+    # @return [Array[OrderTrackerResponse]]
+    attr_accessor :trackers
+
     # The name of the party.
     # @return [ShippingName]
     attr_accessor :name
@@ -22,7 +26,7 @@ module PaypalServerSdk
 
     # The phone number in its canonical international [E.164 numbering plan
     # format](https://www.itu.int/rec/T-REC-E.164/en).
-    # @return [PhoneNumberWithCountryCode]
+    # @return [PhoneNumberWithOptionalCountryCode]
     attr_accessor :phone_number
 
     # A classification for the method of purchase fulfillment (e.g shipping,
@@ -45,33 +49,29 @@ module PaypalServerSdk
     # @return [Address]
     attr_accessor :address
 
-    # An array of trackers for a transaction.
-    # @return [Array[OrderTrackerResponse]]
-    attr_accessor :trackers
-
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
+      @_hash['trackers'] = 'trackers'
       @_hash['name'] = 'name'
       @_hash['email_address'] = 'email_address'
       @_hash['phone_number'] = 'phone_number'
       @_hash['type'] = 'type'
       @_hash['options'] = 'options'
       @_hash['address'] = 'address'
-      @_hash['trackers'] = 'trackers'
       @_hash
     end
 
     # An array for optional fields
     def self.optionals
       %w[
+        trackers
         name
         email_address
         phone_number
         type
         options
         address
-        trackers
       ]
     end
 
@@ -80,15 +80,15 @@ module PaypalServerSdk
       []
     end
 
-    def initialize(name: SKIP, email_address: SKIP, phone_number: SKIP,
-                   type: SKIP, options: SKIP, address: SKIP, trackers: SKIP)
+    def initialize(trackers: SKIP, name: SKIP, email_address: SKIP,
+                   phone_number: SKIP, type: SKIP, options: SKIP, address: SKIP)
+      @trackers = trackers unless trackers == SKIP
       @name = name unless name == SKIP
       @email_address = email_address unless email_address == SKIP
       @phone_number = phone_number unless phone_number == SKIP
       @type = type unless type == SKIP
       @options = options unless options == SKIP
       @address = address unless address == SKIP
-      @trackers = trackers unless trackers == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -96,9 +96,19 @@ module PaypalServerSdk
       return nil unless hash
 
       # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      trackers = nil
+      unless hash['trackers'].nil?
+        trackers = []
+        hash['trackers'].each do |structure|
+          trackers << (OrderTrackerResponse.from_hash(structure) if structure)
+        end
+      end
+
+      trackers = SKIP unless hash.key?('trackers')
       name = ShippingName.from_hash(hash['name']) if hash['name']
       email_address = hash.key?('email_address') ? hash['email_address'] : SKIP
-      phone_number = PhoneNumberWithCountryCode.from_hash(hash['phone_number']) if
+      phone_number = PhoneNumberWithOptionalCountryCode.from_hash(hash['phone_number']) if
         hash['phone_number']
       type = hash.key?('type') ? hash['type'] : SKIP
       # Parameter is an array, so we need to iterate through it
@@ -112,41 +122,31 @@ module PaypalServerSdk
 
       options = SKIP unless hash.key?('options')
       address = Address.from_hash(hash['address']) if hash['address']
-      # Parameter is an array, so we need to iterate through it
-      trackers = nil
-      unless hash['trackers'].nil?
-        trackers = []
-        hash['trackers'].each do |structure|
-          trackers << (OrderTrackerResponse.from_hash(structure) if structure)
-        end
-      end
-
-      trackers = SKIP unless hash.key?('trackers')
 
       # Create object from extracted values.
-      ShippingWithTrackingDetails.new(name: name,
+      ShippingWithTrackingDetails.new(trackers: trackers,
+                                      name: name,
                                       email_address: email_address,
                                       phone_number: phone_number,
                                       type: type,
                                       options: options,
-                                      address: address,
-                                      trackers: trackers)
+                                      address: address)
     end
 
     # Provides a human-readable string representation of the object.
     def to_s
       class_name = self.class.name.split('::').last
-      "<#{class_name} name: #{@name}, email_address: #{@email_address}, phone_number:"\
-      " #{@phone_number}, type: #{@type}, options: #{@options}, address: #{@address}, trackers:"\
-      " #{@trackers}>"
+      "<#{class_name} trackers: #{@trackers}, name: #{@name}, email_address: #{@email_address},"\
+      " phone_number: #{@phone_number}, type: #{@type}, options: #{@options}, address:"\
+      " #{@address}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
     def inspect
       class_name = self.class.name.split('::').last
-      "<#{class_name} name: #{@name.inspect}, email_address: #{@email_address.inspect},"\
-      " phone_number: #{@phone_number.inspect}, type: #{@type.inspect}, options:"\
-      " #{@options.inspect}, address: #{@address.inspect}, trackers: #{@trackers.inspect}>"
+      "<#{class_name} trackers: #{@trackers.inspect}, name: #{@name.inspect}, email_address:"\
+      " #{@email_address.inspect}, phone_number: #{@phone_number.inspect}, type: #{@type.inspect},"\
+      " options: #{@options.inspect}, address: #{@address.inspect}>"
     end
   end
 end

data/lib/paypal_server_sdk/models/simple_postal_address_coarse_grained.rb

@@ -0,0 +1,130 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # A simple postal address with coarse-grained fields. Do not use for an
+  # international address. Use for backward compatibility only. Does not contain
+  # phone.
+  class SimplePostalAddressCoarseGrained < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The first line of the address. For example, number or street.
+    # @return [String]
+    attr_accessor :line1
+
+    # The second line of the address. For example, suite or apartment number.
+    # @return [String]
+    attr_accessor :line2
+
+    # The city name.
+    # @return [String]
+    attr_accessor :city
+
+    # The [code](/docs/api/reference/state-codes/) for a US state or the
+    # equivalent for other countries. Required for transactions if the address
+    # is in one of these countries:
+    # [Argentina](/docs/api/reference/state-codes/#argentina),
+    # [Brazil](/docs/api/reference/state-codes/#brazil),
+    # [Canada](/docs/api/reference/state-codes/#canada),
+    # [China](/docs/api/reference/state-codes/#china),
+    # [India](/docs/api/reference/state-codes/#india),
+    # [Italy](/docs/api/reference/state-codes/#italy),
+    # [Japan](/docs/api/reference/state-codes/#japan),
+    # [Mexico](/docs/api/reference/state-codes/#mexico),
+    # [Thailand](/docs/api/reference/state-codes/#thailand), or [United
+    # States](/docs/api/reference/state-codes/#usa). Maximum length is 40
+    # single-byte characters.
+    # @return [String]
+    attr_accessor :state
+
+    # The [two-character ISO 3166-1
+    # code](/docs/integration/direct/rest/country-codes/) that identifies the
+    # country or region. Note: The country code for Great Britain is GB and not
+    # UK 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.
+    # @return [String]
+    attr_accessor :country_code
+
+    # The postal code, which is the zip code or equivalent. Typically required
+    # for countries with a postal code or an equivalent. See [postal
+    # code](https://en.wikipedia.org/wiki/Postal_code).
+    # @return [String]
+    attr_accessor :postal_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['line1'] = 'line1'
+      @_hash['line2'] = 'line2'
+      @_hash['city'] = 'city'
+      @_hash['state'] = 'state'
+      @_hash['country_code'] = 'country_code'
+      @_hash['postal_code'] = 'postal_code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        line2
+        state
+        postal_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(line1:, city:, country_code:, line2: SKIP, state: SKIP,
+                   postal_code: SKIP)
+      @line1 = line1
+      @line2 = line2 unless line2 == SKIP
+      @city = city
+      @state = state unless state == SKIP
+      @country_code = country_code
+      @postal_code = postal_code unless postal_code == 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.
+      line1 = hash.key?('line1') ? hash['line1'] : nil
+      city = hash.key?('city') ? hash['city'] : nil
+      country_code = hash.key?('country_code') ? hash['country_code'] : nil
+      line2 = hash.key?('line2') ? hash['line2'] : SKIP
+      state = hash.key?('state') ? hash['state'] : SKIP
+      postal_code = hash.key?('postal_code') ? hash['postal_code'] : SKIP
+
+      # Create object from extracted values.
+      SimplePostalAddressCoarseGrained.new(line1: line1,
+                                           city: city,
+                                           country_code: country_code,
+                                           line2: line2,
+                                           state: state,
+                                           postal_code: postal_code)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} line1: #{@line1}, line2: #{@line2}, city: #{@city}, state: #{@state},"\
+      " country_code: #{@country_code}, postal_code: #{@postal_code}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} line1: #{@line1.inspect}, line2: #{@line2.inspect}, city: #{@city.inspect},"\
+      " state: #{@state.inspect}, country_code: #{@country_code.inspect}, postal_code:"\
+      " #{@postal_code.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/sofort_payment_object.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # Information used to pay using Sofort.

data/lib/paypal_server_sdk/models/sofort_payment_request.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # Information needed to pay using Sofort.

data/lib/paypal_server_sdk/models/standard_entry_class_code.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # NACHA (the regulatory body governing the ACH network) requires that API

data/lib/paypal_server_sdk/models/store_in_vault_instruction.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # Defines how and when the payment source gets vaulted.

data/lib/paypal_server_sdk/models/store_information.rb

@@ -0,0 +1,71 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The store information.
+  class StoreInformation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of a store for a merchant in the system of record.
+    # @return [String]
+    attr_accessor :store_id
+
+    # The terminal ID for the checkout stand in a merchant store.
+    # @return [String]
+    attr_accessor :terminal_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['store_id'] = 'store_id'
+      @_hash['terminal_id'] = 'terminal_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        store_id
+        terminal_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(store_id: SKIP, terminal_id: SKIP)
+      @store_id = store_id unless store_id == SKIP
+      @terminal_id = terminal_id unless terminal_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.
+      store_id = hash.key?('store_id') ? hash['store_id'] : SKIP
+      terminal_id = hash.key?('terminal_id') ? hash['terminal_id'] : SKIP
+
+      # Create object from extracted values.
+      StoreInformation.new(store_id: store_id,
+                           terminal_id: terminal_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} store_id: #{@store_id}, terminal_id: #{@terminal_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} store_id: #{@store_id.inspect}, terminal_id: #{@terminal_id.inspect}>"
+    end
+  end
+end