cli-sdk 1.0.0 → 10.0.1

data/lib/paypal_server_sdk/models/order_request.rb

@@ -0,0 +1,132 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.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 instruction to process an order.
+    # @return [ProcessingInstruction]
+    attr_accessor :processing_instruction
+
+    # DEPRECATED. The customer is also known as the payer. The Payer object was
+    # intended to only be used with the `payment_source.paypal` object. In order
+    # to make this design more clear, the details in the `payer` object are now
+    # available under `payment_source.paypal`. Please use
+    # `payment_source.paypal`.
+    # @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. Note: Partners and Marketplaces might configure
+    # brand_name and shipping_preference during partner account setup, which
+    # overrides the request values.
+    # @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['processing_instruction'] = 'processing_instruction'
+      @_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[
+        processing_instruction
+        payer
+        payment_source
+        application_context
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(intent:, purchase_units:, processing_instruction: SKIP,
+                   payer: SKIP, payment_source: SKIP, application_context: SKIP)
+      @intent = intent
+      @processing_instruction = processing_instruction unless processing_instruction == SKIP
+      @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')
+      processing_instruction =
+        hash.key?('processing_instruction') ? hash['processing_instruction'] : SKIP
+      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,
+                       processing_instruction: processing_instruction,
+                       payer: payer,
+                       payment_source: payment_source,
+                       application_context: application_context)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} intent: #{@intent}, processing_instruction: #{@processing_instruction},"\
+      " payer: #{@payer}, purchase_units: #{@purchase_units}, payment_source: #{@payment_source},"\
+      " application_context: #{@application_context}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} intent: #{@intent.inspect}, processing_instruction:"\
+      " #{@processing_instruction.inspect}, payer: #{@payer.inspect}, purchase_units:"\
+      " #{@purchase_units.inspect}, payment_source: #{@payment_source.inspect},"\
+      " application_context: #{@application_context.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/order_status.rb

@@ -0,0 +1,65 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The order status.
+  class OrderStatus
+    ORDER_STATUS = [
+      # The order was created with the specified context.
+      CREATED = 'CREATED'.freeze,
+
+      # The order was saved and persisted. The order status continues to be in
+      # progress until a capture is made with final_capture = true for all
+      # purchase units within the order.
+      SAVED = 'SAVED'.freeze,
+
+      # The customer approved the payment through the PayPal wallet or another
+      # form of guest or unbranded payment. For example, a card, bank account,
+      # or so on.
+      APPROVED = 'APPROVED'.freeze,
+
+      # All purchase units in the order are voided.
+      VOIDED = 'VOIDED'.freeze,
+
+      # The intent of the order was completed and a `payments` resource was
+      # created. Important: Check the payment status in
+      # `purchase_units[].payments.captures[].status` before fulfilling the
+      # order. A completed order can indicate a payment was authorized, an
+      # authorized payment was captured, or a payment was declined.
+      COMPLETED = 'COMPLETED'.freeze,
+
+      # The order requires an action from the payer (e.g. 3DS authentication).
+      # Redirect the payer to the "rel":"payer-action" HATEOAS link returned as
+      # part of the response prior to authorizing or capturing the order. Some
+      # payment sources may not return a payer-action HATEOAS link (eg. MB WAY).
+      # For these payment sources the payer-action is managed by the scheme
+      # itself (eg. through SMS, email, in-app notification, etc).
+      PAYER_ACTION_REQUIRED = 'PAYER_ACTION_REQUIRED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CREATED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'created' then CREATED
+      when 'saved' then SAVED
+      when 'approved' then APPROVED
+      when 'voided' then VOIDED
+      when 'completed' then COMPLETED
+      when 'payer_action_required' then PAYER_ACTION_REQUIRED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/order_tracker_item.rb

@@ -0,0 +1,114 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.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
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, quantity: #{@quantity}, sku: #{@sku}, url: #{@url},"\
+      " image_url: #{@image_url}, upc: #{@upc}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, quantity: #{@quantity.inspect}, sku:"\
+      " #{@sku.inspect}, url: #{@url.inspect}, image_url: #{@image_url.inspect}, upc:"\
+      " #{@upc.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/order_tracker_request.rb

@@ -0,0 +1,133 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.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 Carriers.
+    # @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, PayPal will send an email notification to the payer of the PayPal
+    # transaction. The email contains the tracking details provided through the
+    # Orders tracking API request. Independent of any value passed for
+    # `notify_payer`, the payer may receive tracking notifications within the
+    # PayPal app, based on the user's notification preferences.
+    # @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
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} tracking_number: #{@tracking_number}, carrier: #{@carrier},"\
+      " carrier_name_other: #{@carrier_name_other}, capture_id: #{@capture_id}, notify_payer:"\
+      " #{@notify_payer}, items: #{@items}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} tracking_number: #{@tracking_number.inspect}, carrier: #{@carrier.inspect},"\
+      " carrier_name_other: #{@carrier_name_other.inspect}, capture_id: #{@capture_id.inspect},"\
+      " notify_payer: #{@notify_payer.inspect}, items: #{@items.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/order_tracker_response.rb

@@ -0,0 +1,135 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.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. 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. Note: The regular
+    # expression provides guidance but does not reject all invalid dates.
+    # @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
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, status: #{@status}, items: #{@items}, links: #{@links},"\
+      " 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} id: #{@id.inspect}, status: #{@status.inspect}, items: #{@items.inspect},"\
+      " links: #{@links.inspect}, create_time: #{@create_time.inspect}, update_time:"\
+      " #{@update_time.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/order_tracker_status.rb

@@ -0,0 +1,39 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The status of the item shipment.
+  class OrderTrackerStatus
+    ORDER_TRACKER_STATUS = [
+      # The shipment was cancelled and the tracking number no longer applies.
+      CANCELLED = 'CANCELLED'.freeze,
+
+      # The merchant has assigned a tracking number to the items being shipped
+      # from the Order. This does not correspond to the carrier's actual status
+      # for the shipment. The latest status of the parcel must be retrieved from
+      # the carrier.
+      SHIPPED = 'SHIPPED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CANCELLED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'cancelled' then CANCELLED
+      when 'shipped' then SHIPPED
+      else
+        default_value
+      end
+    end
+  end
+end