cli-sdk 1.0.0 → 10.0.1

data/lib/paypal_server_sdk/models/o_auth_provider_error.rb

@@ -0,0 +1,62 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # OAuth 2 Authorization error codes
+  class OAuthProviderError
+    O_AUTH_PROVIDER_ERROR = [
+      # The request is missing a required parameter, includes an unsupported
+      # parameter value (other than grant type), repeats a parameter, includes
+      # multiple credentials, utilizes more than one mechanism for
+      # authenticating the client, or is otherwise malformed.
+      INVALID_REQUEST = 'invalid_request'.freeze,
+
+      # Client authentication failed (e.g., unknown client, no client
+      # authentication included, or unsupported authentication method).
+      INVALID_CLIENT = 'invalid_client'.freeze,
+
+      # The provided authorization grant (e.g., authorization code, resource
+      # owner credentials) or refresh token is invalid, expired, revoked, does
+      # not match the redirection URI used in the authorization request, or was
+      # issued to another client.
+      INVALID_GRANT = 'invalid_grant'.freeze,
+
+      # The authenticated client is not authorized to use this authorization
+      # grant type.
+      UNAUTHORIZED_CLIENT = 'unauthorized_client'.freeze,
+
+      # The authorization grant type is not supported by the authorization
+      # server.
+      UNSUPPORTED_GRANT_TYPE = 'unsupported_grant_type'.freeze,
+
+      # The requested scope is invalid, unknown, malformed, or exceeds the scope
+      # granted by the resource owner.
+      INVALID_SCOPE = 'invalid_scope'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      O_AUTH_PROVIDER_ERROR.include?(value)
+    end
+
+    def self.from_value(value, default_value = INVALID_REQUEST)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'invalid_request' then INVALID_REQUEST
+      when 'invalid_client' then INVALID_CLIENT
+      when 'invalid_grant' then INVALID_GRANT
+      when 'unauthorized_client' then UNAUTHORIZED_CLIENT
+      when 'unsupported_grant_type' then UNSUPPORTED_GRANT_TYPE
+      when 'invalid_scope' then INVALID_SCOPE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/o_auth_token.rb

@@ -0,0 +1,106 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # OAuth 2 Authorization endpoint response
+  class OAuthToken < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Access token
+    # @return [String]
+    attr_accessor :access_token
+
+    # Type of access token
+    # @return [String]
+    attr_accessor :token_type
+
+    # Time in seconds before the access token expires
+    # @return [Integer]
+    attr_accessor :expires_in
+
+    # List of scopes granted
+    # This is a space-delimited list of strings.
+    # @return [String]
+    attr_accessor :scope
+
+    # Time of token expiry as unix timestamp (UTC)
+    # @return [Integer]
+    attr_accessor :expiry
+
+    # Refresh token
+    # Used to get a new access token when it expires.
+    # @return [String]
+    attr_accessor :refresh_token
+
+    # An ID token response type is of JSON Web Token (JWT) that contains claims
+    # about the identity of the authenticated user.
+    # @return [String]
+    attr_accessor :id_token
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['access_token'] = 'access_token'
+      @_hash['token_type'] = 'token_type'
+      @_hash['expires_in'] = 'expires_in'
+      @_hash['scope'] = 'scope'
+      @_hash['expiry'] = 'expiry'
+      @_hash['refresh_token'] = 'refresh_token'
+      @_hash['id_token'] = 'id_token'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        expires_in
+        scope
+        expiry
+        refresh_token
+        id_token
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(access_token:, token_type:, expires_in: SKIP, scope: SKIP,
+                   expiry: SKIP, refresh_token: SKIP, id_token: SKIP)
+      @access_token = access_token
+      @token_type = token_type
+      @expires_in = expires_in unless expires_in == SKIP
+      @scope = scope unless scope == SKIP
+      @expiry = expiry unless expiry == SKIP
+      @refresh_token = refresh_token unless refresh_token == SKIP
+      @id_token = id_token unless id_token == 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.
+      access_token = hash.key?('access_token') ? hash['access_token'] : nil
+      token_type = hash.key?('token_type') ? hash['token_type'] : nil
+      expires_in = hash.key?('expires_in') ? hash['expires_in'] : SKIP
+      scope = hash.key?('scope') ? hash['scope'] : SKIP
+      expiry = hash.key?('expiry') ? hash['expiry'] : SKIP
+      refresh_token = hash.key?('refresh_token') ? hash['refresh_token'] : SKIP
+      id_token = hash.key?('id_token') ? hash['id_token'] : SKIP
+
+      # Create object from extracted values.
+      OAuthToken.new(access_token: access_token,
+                     token_type: token_type,
+                     expires_in: expires_in,
+                     scope: scope,
+                     expiry: expiry,
+                     refresh_token: refresh_token,
+                     id_token: id_token)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/one_time_charge.rb

@@ -0,0 +1,118 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The one-time charge info at the time of checkout.
+  class OneTimeCharge < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :setup_fee
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :shipping_amount
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :taxes
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :product_price
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :subtotal
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :total_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['setup_fee'] = 'setup_fee'
+      @_hash['shipping_amount'] = 'shipping_amount'
+      @_hash['taxes'] = 'taxes'
+      @_hash['product_price'] = 'product_price'
+      @_hash['subtotal'] = 'subtotal'
+      @_hash['total_amount'] = 'total_amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        setup_fee
+        shipping_amount
+        taxes
+        product_price
+        subtotal
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(total_amount:, setup_fee: SKIP, shipping_amount: SKIP,
+                   taxes: SKIP, product_price: SKIP, subtotal: SKIP)
+      @setup_fee = setup_fee unless setup_fee == SKIP
+      @shipping_amount = shipping_amount unless shipping_amount == SKIP
+      @taxes = taxes unless taxes == SKIP
+      @product_price = product_price unless product_price == SKIP
+      @subtotal = subtotal unless subtotal == SKIP
+      @total_amount = total_amount
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      total_amount = Money.from_hash(hash['total_amount']) if hash['total_amount']
+      setup_fee = Money.from_hash(hash['setup_fee']) if hash['setup_fee']
+      shipping_amount = Money.from_hash(hash['shipping_amount']) if hash['shipping_amount']
+      taxes = Money.from_hash(hash['taxes']) if hash['taxes']
+      product_price = Money.from_hash(hash['product_price']) if hash['product_price']
+      subtotal = Money.from_hash(hash['subtotal']) if hash['subtotal']
+
+      # Create object from extracted values.
+      OneTimeCharge.new(total_amount: total_amount,
+                        setup_fee: setup_fee,
+                        shipping_amount: shipping_amount,
+                        taxes: taxes,
+                        product_price: product_price,
+                        subtotal: subtotal)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} setup_fee: #{@setup_fee}, shipping_amount: #{@shipping_amount}, taxes:"\
+      " #{@taxes}, product_price: #{@product_price}, subtotal: #{@subtotal}, total_amount:"\
+      " #{@total_amount}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} setup_fee: #{@setup_fee.inspect}, shipping_amount:"\
+      " #{@shipping_amount.inspect}, taxes: #{@taxes.inspect}, product_price:"\
+      " #{@product_price.inspect}, subtotal: #{@subtotal.inspect}, total_amount:"\
+      " #{@total_amount.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/order.rb

@@ -0,0 +1,197 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The order details.
+  class Order < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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
+
+    # The ID of the order.
+    # @return [String]
+    attr_accessor :id
+
+    # The payment source used to fund the payment.
+    # @return [PaymentSourceResponse]
+    attr_accessor :payment_source
+
+    # 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 customer and merchant. Each purchase unit represents either a
+    # full or partial order that the customer intends to purchase from the
+    # merchant.
+    # @return [Array[PurchaseUnit]]
+    attr_accessor :purchase_units
+
+    # The order status.
+    # @return [OrderStatus]
+    attr_accessor :status
+
+    # An array of request-related HATEOAS links. To complete payer approval, use
+    # the `approve` link to redirect the payer. The API caller has 6 hours
+    # (default setting, this which can be changed by your account manager to
+    # 24/48/72 hours to accommodate your use case) from the time the order is
+    # created, to redirect your payer. Once redirected, the API caller has 6
+    # hours for the payer to approve the order and either authorize or capture
+    # the order. If you are not using the PayPal JavaScript SDK to initiate
+    # PayPal Checkout (in context) ensure that you include
+    # `application_context.return_url` is specified or you will get "We're
+    # sorry, Things don't appear to be working at the moment" after the payer
+    # approves the payment.
+    # @return [Array[LinkDescription]]
+    attr_accessor :links
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['create_time'] = 'create_time'
+      @_hash['update_time'] = 'update_time'
+      @_hash['id'] = 'id'
+      @_hash['payment_source'] = 'payment_source'
+      @_hash['intent'] = 'intent'
+      @_hash['processing_instruction'] = 'processing_instruction'
+      @_hash['payer'] = 'payer'
+      @_hash['purchase_units'] = 'purchase_units'
+      @_hash['status'] = 'status'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        create_time
+        update_time
+        id
+        payment_source
+        intent
+        processing_instruction
+        payer
+        purchase_units
+        status
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(create_time: SKIP, update_time: SKIP, id: SKIP,
+                   payment_source: SKIP, intent: SKIP,
+                   processing_instruction: SKIP, payer: SKIP,
+                   purchase_units: SKIP, status: SKIP, links: SKIP)
+      @create_time = create_time unless create_time == SKIP
+      @update_time = update_time unless update_time == SKIP
+      @id = id unless id == SKIP
+      @payment_source = payment_source unless payment_source == SKIP
+      @intent = intent unless intent == SKIP
+      @processing_instruction = processing_instruction unless processing_instruction == SKIP
+      @payer = payer unless payer == SKIP
+      @purchase_units = purchase_units unless purchase_units == SKIP
+      @status = status unless status == SKIP
+      @links = links unless links == 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.
+      create_time = hash.key?('create_time') ? hash['create_time'] : SKIP
+      update_time = hash.key?('update_time') ? hash['update_time'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      payment_source = PaymentSourceResponse.from_hash(hash['payment_source']) if
+        hash['payment_source']
+      intent = hash.key?('intent') ? hash['intent'] : SKIP
+      processing_instruction =
+        hash.key?('processing_instruction') ? hash['processing_instruction'] : SKIP
+      payer = Payer.from_hash(hash['payer']) if hash['payer']
+      # 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 << (PurchaseUnit.from_hash(structure) if structure)
+        end
+      end
+
+      purchase_units = SKIP unless hash.key?('purchase_units')
+      status = hash.key?('status') ? hash['status'] : SKIP
+      # 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 object from extracted values.
+      Order.new(create_time: create_time,
+                update_time: update_time,
+                id: id,
+                payment_source: payment_source,
+                intent: intent,
+                processing_instruction: processing_instruction,
+                payer: payer,
+                purchase_units: purchase_units,
+                status: status,
+                links: links)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} create_time: #{@create_time}, update_time: #{@update_time}, id: #{@id},"\
+      " payment_source: #{@payment_source}, intent: #{@intent}, processing_instruction:"\
+      " #{@processing_instruction}, payer: #{@payer}, purchase_units: #{@purchase_units}, status:"\
+      " #{@status}, links: #{@links}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} create_time: #{@create_time.inspect}, update_time: #{@update_time.inspect},"\
+      " id: #{@id.inspect}, payment_source: #{@payment_source.inspect}, intent:"\
+      " #{@intent.inspect}, processing_instruction: #{@processing_instruction.inspect}, payer:"\
+      " #{@payer.inspect}, purchase_units: #{@purchase_units.inspect}, status: #{@status.inspect},"\
+      " links: #{@links.inspect}>"
+    end
+  end
+end