paypal-server-sdk 0.6.1 → 0.7.0

data/lib/paypal_server_sdk/models/order_update_callback_error_response.rb

@@ -0,0 +1,89 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The error details.
+  class OrderUpdateCallbackErrorResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The human-readable, unique name of the error.
+    # @return [String]
+    attr_accessor :name
+
+    # The message that describes the error.
+    # @return [String]
+    attr_accessor :message
+
+    # An array of additional details about the error.
+    # @return [Array[OrderUpdateCallbackErrorResponseDetails]]
+    attr_accessor :details
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['message'] = 'message'
+      @_hash['details'] = 'details'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        message
+        details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name:, message: SKIP, details: SKIP)
+      @name = name
+      @message = message unless message == SKIP
+      @details = details unless details == 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
+      message = hash.key?('message') ? hash['message'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      details = nil
+      unless hash['details'].nil?
+        details = []
+        hash['details'].each do |structure|
+          details << (OrderUpdateCallbackErrorResponseDetails.from_hash(structure) if structure)
+        end
+      end
+
+      details = SKIP unless hash.key?('details')
+
+      # Create object from extracted values.
+      OrderUpdateCallbackErrorResponse.new(name: name,
+                                           message: message,
+                                           details: details)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, message: #{@message}, details: #{@details}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, message: #{@message.inspect}, details:"\
+      " #{@details.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/order_update_callback_error_response_details.rb

@@ -0,0 +1,81 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The error details. Required for client-side `4XX` errors.
+  class OrderUpdateCallbackErrorResponseDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The field that caused the error. If this field is in the body, set this
+    # value to the field's JSON pointer value. Required for client-side errors.
+    # @return [String]
+    attr_accessor :field
+
+    # The value of the field that caused the error.
+    # @return [String]
+    attr_accessor :value
+
+    # The unique, fine-grained application-level error code.
+    # @return [String]
+    attr_accessor :issue
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['field'] = 'field'
+      @_hash['value'] = 'value'
+      @_hash['issue'] = 'issue'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        field
+        value
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(issue:, field: SKIP, value: SKIP)
+      @field = field unless field == SKIP
+      @value = value unless value == SKIP
+      @issue = issue
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      issue = hash.key?('issue') ? hash['issue'] : nil
+      field = hash.key?('field') ? hash['field'] : SKIP
+      value = hash.key?('value') ? hash['value'] : SKIP
+
+      # Create object from extracted values.
+      OrderUpdateCallbackErrorResponseDetails.new(issue: issue,
+                                                  field: field,
+                                                  value: value)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} field: #{@field}, value: #{@value}, issue: #{@issue}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} field: #{@field.inspect}, value: #{@value.inspect}, issue:"\
+      " #{@issue.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/order_update_callback_request.rb

@@ -0,0 +1,111 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Shipping Options Callback request. This will be implemented by the
+  # merchants.
+  class OrderUpdateCallbackRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the order.
+    # @return [String]
+    attr_accessor :id
+
+    # 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 [OrderUpdateCallbackShippingAddress]
+    attr_accessor :shipping_address
+
+    # The options that the payee or merchant offers to the payer to ship or pick
+    # up their items.
+    # @return [OrderUpdateCallbackShippingOption]
+    attr_accessor :shipping_option
+
+    # An array of purchase units. At present only 1 purchase_unit is supported.
+    # 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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['shipping_address'] = 'shipping_address'
+      @_hash['shipping_option'] = 'shipping_option'
+      @_hash['purchase_units'] = 'purchase_units'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        shipping_option
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(shipping_address:, purchase_units:, id: SKIP,
+                   shipping_option: SKIP)
+      @id = id unless id == SKIP
+      @shipping_address = shipping_address
+      @shipping_option = shipping_option unless shipping_option == SKIP
+      @purchase_units = purchase_units
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      shipping_address = OrderUpdateCallbackShippingAddress.from_hash(hash['shipping_address']) if
+        hash['shipping_address']
+      # 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')
+      id = hash.key?('id') ? hash['id'] : SKIP
+      shipping_option = OrderUpdateCallbackShippingOption.from_hash(hash['shipping_option']) if
+        hash['shipping_option']
+
+      # Create object from extracted values.
+      OrderUpdateCallbackRequest.new(shipping_address: shipping_address,
+                                     purchase_units: purchase_units,
+                                     id: id,
+                                     shipping_option: shipping_option)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, shipping_address: #{@shipping_address}, shipping_option:"\
+      " #{@shipping_option}, purchase_units: #{@purchase_units}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, shipping_address: #{@shipping_address.inspect},"\
+      " shipping_option: #{@shipping_option.inspect}, purchase_units: #{@purchase_units.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/order_update_callback_response.rb

@@ -0,0 +1,72 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Returns the updated shipping options for an order.
+  class OrderUpdateCallbackResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the order.
+    # @return [String]
+    attr_accessor :id
+
+    # This would contain shipping option and amount data at purchase unit level.
+    # @return [ShippingOptionsPurchaseUnit]
+    attr_accessor :purchase_units
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['purchase_units'] = 'purchase_units'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        purchase_units
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, purchase_units: SKIP)
+      @id = id unless id == SKIP
+      @purchase_units = purchase_units unless purchase_units == 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
+      purchase_units = ShippingOptionsPurchaseUnit.from_hash(hash['purchase_units']) if
+        hash['purchase_units']
+
+      # Create object from extracted values.
+      OrderUpdateCallbackResponse.new(id: id,
+                                      purchase_units: purchase_units)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, purchase_units: #{@purchase_units}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, purchase_units: #{@purchase_units.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/order_update_callback_shipping_address.rb

@@ -0,0 +1,107 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The portable international postal address. Maps to
+  # [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wi
+  # ki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the
+  # autocomplete
+  # attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-cont
+  # rols-the-autocomplete-attribute).
+  class OrderUpdateCallbackShippingAddress < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A city, town, or village. Smaller than `admin_area_level_1`.
+    # @return [String]
+    attr_accessor :admin_area_2
+
+    # The highest-level sub-division in a country, which is usually a province,
+    # state, or ISO-3166-2 subdivision. This data is formatted for postal
+    # delivery, for example, `CA` and not `California`. Value, by country, is:
+    # UK. A county. US. A state. Canada. A province. Japan. A prefecture.
+    # Switzerland. A *kanton*.
+    # @return [String]
+    attr_accessor :admin_area_1
+
+    # 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
+
+    # The [2-character ISO 3166-1 code](/api/rest/reference/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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['admin_area_2'] = 'admin_area_2'
+      @_hash['admin_area_1'] = 'admin_area_1'
+      @_hash['postal_code'] = 'postal_code'
+      @_hash['country_code'] = 'country_code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        admin_area_2
+        admin_area_1
+        postal_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(country_code:, admin_area_2: SKIP, admin_area_1: SKIP,
+                   postal_code: SKIP)
+      @admin_area_2 = admin_area_2 unless admin_area_2 == SKIP
+      @admin_area_1 = admin_area_1 unless admin_area_1 == SKIP
+      @postal_code = postal_code unless postal_code == SKIP
+      @country_code = country_code
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      country_code = hash.key?('country_code') ? hash['country_code'] : nil
+      admin_area_2 = hash.key?('admin_area_2') ? hash['admin_area_2'] : SKIP
+      admin_area_1 = hash.key?('admin_area_1') ? hash['admin_area_1'] : SKIP
+      postal_code = hash.key?('postal_code') ? hash['postal_code'] : SKIP
+
+      # Create object from extracted values.
+      OrderUpdateCallbackShippingAddress.new(country_code: country_code,
+                                             admin_area_2: admin_area_2,
+                                             admin_area_1: admin_area_1,
+                                             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} admin_area_2: #{@admin_area_2}, admin_area_1: #{@admin_area_1},"\
+      " postal_code: #{@postal_code}, country_code: #{@country_code}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} admin_area_2: #{@admin_area_2.inspect}, admin_area_1:"\
+      " #{@admin_area_1.inspect}, postal_code: #{@postal_code.inspect}, country_code:"\
+      " #{@country_code.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/order_update_callback_shipping_option.rb

@@ -0,0 +1,93 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The options that the payee or merchant offers to the payer to ship or pick
+  # up their items.
+  class OrderUpdateCallbackShippingOption < 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
+
+    # 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
+    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:, type: SKIP, amount: SKIP)
+      @id = id
+      @label = label
+      @type = type unless type == SKIP
+      @amount = amount unless amount == 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'] : nil
+      label = hash.key?('label') ? hash['label'] : nil
+      type = hash.key?('type') ? hash['type'] : SKIP
+      amount = Money.from_hash(hash['amount']) if hash['amount']
+
+      # Create object from extracted values.
+      OrderUpdateCallbackShippingOption.new(id: id,
+                                            label: label,
+                                            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}>"
+    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}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/{capture.rb → orders_capture.rb}

@@ -5,7 +5,7 @@
 
 module PaypalServerSdk
   # A captured payment.
-  class Capture < BaseModel
+  class OrdersCapture < BaseModel
     SKIP = Object.new
     private_constant :SKIP
 
@@ -77,17 +77,15 @@ module PaypalServerSdk
 
     # 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>
+    # required while fractional seconds are optional. Note: The regular
+    # expression provides guidance but does not reject all invalid dates.
     # @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>
+    # required while fractional seconds are optional. Note: The regular
+    # expression provides guidance but does not reject all invalid dates.
     # @return [String]
     attr_accessor :update_time
 
@@ -208,21 +206,47 @@ module PaypalServerSdk
       update_time = hash.key?('update_time') ? hash['update_time'] : SKIP
 
       # Create object from extracted values.
-      Capture.new(status: status,
-                  status_details: status_details,
-                  id: id,
-                  amount: amount,
-                  invoice_id: invoice_id,
-                  custom_id: custom_id,
-                  network_transaction_reference: network_transaction_reference,
-                  seller_protection: seller_protection,
-                  final_capture: final_capture,
-                  seller_receivable_breakdown: seller_receivable_breakdown,
-                  disbursement_mode: disbursement_mode,
-                  links: links,
-                  processor_response: processor_response,
-                  create_time: create_time,
-                  update_time: update_time)
+      OrdersCapture.new(status: status,
+                        status_details: status_details,
+                        id: id,
+                        amount: amount,
+                        invoice_id: invoice_id,
+                        custom_id: custom_id,
+                        network_transaction_reference: network_transaction_reference,
+                        seller_protection: seller_protection,
+                        final_capture: final_capture,
+                        seller_receivable_breakdown: seller_receivable_breakdown,
+                        disbursement_mode: disbursement_mode,
+                        links: links,
+                        processor_response: processor_response,
+                        create_time: create_time,
+                        update_time: update_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status: #{@status}, status_details: #{@status_details}, id: #{@id}, amount:"\
+      " #{@amount}, invoice_id: #{@invoice_id}, custom_id: #{@custom_id},"\
+      " network_transaction_reference: #{@network_transaction_reference}, seller_protection:"\
+      " #{@seller_protection}, final_capture: #{@final_capture}, seller_receivable_breakdown:"\
+      " #{@seller_receivable_breakdown}, disbursement_mode: #{@disbursement_mode}, links:"\
+      " #{@links}, processor_response: #{@processor_response}, create_time: #{@create_time},"\
+      " update_time: #{@update_time}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status: #{@status.inspect}, status_details: #{@status_details.inspect}, id:"\
+      " #{@id.inspect}, amount: #{@amount.inspect}, invoice_id: #{@invoice_id.inspect}, custom_id:"\
+      " #{@custom_id.inspect}, network_transaction_reference:"\
+      " #{@network_transaction_reference.inspect}, seller_protection:"\
+      " #{@seller_protection.inspect}, final_capture: #{@final_capture.inspect},"\
+      " seller_receivable_breakdown: #{@seller_receivable_breakdown.inspect}, disbursement_mode:"\
+      " #{@disbursement_mode.inspect}, links: #{@links.inspect}, processor_response:"\
+      " #{@processor_response.inspect}, create_time: #{@create_time.inspect}, update_time:"\
+      " #{@update_time.inspect}>"
     end
   end
 end