cli-sdk 1.0.0 → 10.0.1

data/lib/paypal_server_sdk/models/shipping_details.rb

@@ -0,0 +1,133 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The shipping details.
+  class ShippingDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the party.
+    # @return [ShippingName]
+    attr_accessor :name
+
+    # The internationalized email address. Note: Up to 64 characters are allowed
+    # before and 255 characters are allowed after the @ sign. However, the
+    # generally accepted maximum length for an email address is 254 characters.
+    # The pattern verifies that an unquoted @ sign exists.
+    # @return [String]
+    attr_accessor :email_address
+
+    # The phone number in its canonical international [E.164 numbering plan
+    # format](https://www.itu.int/rec/T-REC-E.164/en).
+    # @return [PhoneNumberWithCountryCode]
+    attr_accessor :phone_number
+
+    # A classification for the method of purchase fulfillment (e.g shipping,
+    # in-store pickup, etc). Either `type` or `options` may be present, but not
+    # both.
+    # @return [FulfillmentType]
+    attr_accessor :type
+
+    # An array of shipping options that the payee or merchant offers to the
+    # payer to ship or pick up their items.
+    # @return [Array[ShippingOption]]
+    attr_accessor :options
+
+    # The portable international postal address. Maps to
+    # [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/
+    # wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls:
+    # the autocomplete
+    # attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-co
+    # ntrols-the-autocomplete-attribute).
+    # @return [Address]
+    attr_accessor :address
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['email_address'] = 'email_address'
+      @_hash['phone_number'] = 'phone_number'
+      @_hash['type'] = 'type'
+      @_hash['options'] = 'options'
+      @_hash['address'] = 'address'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        email_address
+        phone_number
+        type
+        options
+        address
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, email_address: SKIP, phone_number: SKIP,
+                   type: SKIP, options: SKIP, address: 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
+    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 = 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
+        hash['phone_number']
+      type = hash.key?('type') ? hash['type'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      options = nil
+      unless hash['options'].nil?
+        options = []
+        hash['options'].each do |structure|
+          options << (ShippingOption.from_hash(structure) if structure)
+        end
+      end
+
+      options = SKIP unless hash.key?('options')
+      address = Address.from_hash(hash['address']) if hash['address']
+
+      # Create object from extracted values.
+      ShippingDetails.new(name: name,
+                          email_address: email_address,
+                          phone_number: phone_number,
+                          type: type,
+                          options: options,
+                          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}>"
+    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}>"
+    end
+  end
+end

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

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

data/lib/paypal_server_sdk/models/shipping_option.rb

@@ -0,0 +1,108 @@
+# paypal_server_sdk
+#
+# 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
+  # up their items.
+  class ShippingOption < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A unique ID that identifies a payer-selected shipping option.
+    # @return [String]
+    attr_accessor :id
+
+    # A description that the payer sees, which helps them choose an appropriate
+    # shipping option. For example, `Free Shipping`, `USPS Priority Shipping`,
+    # `Expédition prioritaire USPS`, or `USPS yōuxiān fā huò`. Localize this
+    # description to the payer's locale.
+    # @return [String]
+    attr_accessor :label
+
+    # A classification for the method of purchase fulfillment.
+    # @return [ShippingType]
+    attr_accessor :type
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :amount
+
+    # If the API request sets `selected = true`, it represents the shipping
+    # option that the payee or merchant expects to be pre-selected for the payer
+    # when they first view the `shipping.options` in the PayPal Checkout
+    # experience. As part of the response if a `shipping.option` contains
+    # `selected=true`, it represents the shipping option that the payer selected
+    # during the course of checkout with PayPal. Only one `shipping.option` can
+    # be set to `selected=true`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :selected
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['label'] = 'label'
+      @_hash['type'] = 'type'
+      @_hash['amount'] = 'amount'
+      @_hash['selected'] = 'selected'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id:, label:, selected:, type: SKIP, amount: SKIP)
+      @id = id
+      @label = label
+      @type = type unless type == SKIP
+      @amount = amount unless amount == SKIP
+      @selected = selected
+    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'] : nil
+      label = hash.key?('label') ? hash['label'] : nil
+      selected = hash.key?('selected') ? hash['selected'] : nil
+      type = hash.key?('type') ? hash['type'] : SKIP
+      amount = Money.from_hash(hash['amount']) if hash['amount']
+
+      # Create object from extracted values.
+      ShippingOption.new(id: id,
+                         label: label,
+                         selected: selected,
+                         type: type,
+                         amount: amount)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, label: #{@label}, type: #{@type}, amount: #{@amount}, selected:"\
+      " #{@selected}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, label: #{@label.inspect}, type: #{@type.inspect},"\
+      " amount: #{@amount.inspect}, selected: #{@selected.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/shipping_type.rb

@@ -0,0 +1,52 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # A classification for the method of purchase fulfillment.
+  class ShippingType
+    SHIPPING_TYPE = [
+      # The payer intends to receive the items at a specified address.
+      SHIPPING = 'SHIPPING'.freeze,
+
+      # DEPRECATED. To ensure that seller protection is correctly assigned,
+      # please use 'PICKUP_IN_STORE' or 'PICKUP_FROM_PERSON' instead. Currently,
+      # this field indicates that the payer intends to pick up the items at a
+      # specified address (ie. a store address).
+      PICKUP = 'PICKUP'.freeze,
+
+      # The payer intends to pick up the item(s) from the payee's physical
+      # store. Also termed as BOPIS, "Buy Online, Pick-up in Store". Seller
+      # protection is provided with this option.
+      PICKUP_IN_STORE = 'PICKUP_IN_STORE'.freeze,
+
+      # The payer intends to pick up the item(s) from the payee in person. Also
+      # termed as BOPIP, "Buy Online, Pick-up in Person". Seller protection is
+      # not available, since the payer is receiving the item from the payee in
+      # person, and can validate the item prior to payment.
+      PICKUP_FROM_PERSON = 'PICKUP_FROM_PERSON'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = SHIPPING)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'shipping' then SHIPPING
+      when 'pickup' then PICKUP
+      when 'pickup_in_store' then PICKUP_IN_STORE
+      when 'pickup_from_person' then PICKUP_FROM_PERSON
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/shipping_with_tracking_details.rb

@@ -0,0 +1,152 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # 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
+
+    # The internationalized email address. Note: Up to 64 characters are allowed
+    # before and 255 characters are allowed after the @ sign. However, the
+    # generally accepted maximum length for an email address is 254 characters.
+    # The pattern verifies that an unquoted @ sign exists.
+    # @return [String]
+    attr_accessor :email_address
+
+    # The phone number in its canonical international [E.164 numbering plan
+    # format](https://www.itu.int/rec/T-REC-E.164/en).
+    # @return [PhoneNumberWithOptionalCountryCode]
+    attr_accessor :phone_number
+
+    # A classification for the method of purchase fulfillment (e.g shipping,
+    # in-store pickup, etc). Either `type` or `options` may be present, but not
+    # both.
+    # @return [FulfillmentType]
+    attr_accessor :type
+
+    # An array of shipping options that the payee or merchant offers to the
+    # payer to ship or pick up their items.
+    # @return [Array[ShippingOption]]
+    attr_accessor :options
+
+    # The portable international postal address. Maps to
+    # [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/
+    # wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls:
+    # the autocomplete
+    # attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-co
+    # ntrols-the-autocomplete-attribute).
+    # @return [Address]
+    attr_accessor :address
+
+    # 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
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        trackers
+        name
+        email_address
+        phone_number
+        type
+        options
+        address
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    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
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      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 = 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
+      options = nil
+      unless hash['options'].nil?
+        options = []
+        hash['options'].each do |structure|
+          options << (ShippingOption.from_hash(structure) if structure)
+        end
+      end
+
+      options = SKIP unless hash.key?('options')
+      address = Address.from_hash(hash['address']) if hash['address']
+
+      # Create object from extracted values.
+      ShippingWithTrackingDetails.new(trackers: trackers,
+                                      name: name,
+                                      email_address: email_address,
+                                      phone_number: phone_number,
+                                      type: type,
+                                      options: options,
+                                      address: address)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{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} 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