cli-sdk 1.0.0 → 10.0.1

data/lib/paypal_server_sdk/models/create_subscription_request.rb

@@ -0,0 +1,151 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The create subscription request details.
+  class CreateSubscriptionRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the plan.
+    # @return [String]
+    attr_accessor :plan_id
+
+    # 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 :start_time
+
+    # The quantity of the product in the subscription.
+    # @return [String]
+    attr_accessor :quantity
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :shipping_amount
+
+    # The subscriber request information .
+    # @return [SubscriberRequest]
+    attr_accessor :subscriber
+
+    # DEPRECATED. Indicates whether the subscription auto-renews after the
+    # billing cycles complete.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :auto_renewal
+
+    # DEPRECATED. The application context, which customizes the payer experience
+    # during the subscription approval process with PayPal.
+    # @return [SubscriptionApplicationContext]
+    attr_accessor :application_context
+
+    # The custom id for the subscription. Can be invoice id.
+    # @return [String]
+    attr_accessor :custom_id
+
+    # An inline plan object to customise the subscription. You can override plan
+    # level default attributes by providing customised values for the
+    # subscription in this object.
+    # @return [PlanOverride]
+    attr_accessor :plan
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['plan_id'] = 'plan_id'
+      @_hash['start_time'] = 'start_time'
+      @_hash['quantity'] = 'quantity'
+      @_hash['shipping_amount'] = 'shipping_amount'
+      @_hash['subscriber'] = 'subscriber'
+      @_hash['auto_renewal'] = 'auto_renewal'
+      @_hash['application_context'] = 'application_context'
+      @_hash['custom_id'] = 'custom_id'
+      @_hash['plan'] = 'plan'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        start_time
+        quantity
+        shipping_amount
+        subscriber
+        auto_renewal
+        application_context
+        custom_id
+        plan
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(plan_id:, start_time: SKIP, quantity: SKIP,
+                   shipping_amount: SKIP, subscriber: SKIP, auto_renewal: false,
+                   application_context: SKIP, custom_id: SKIP, plan: SKIP)
+      @plan_id = plan_id
+      @start_time = start_time unless start_time == SKIP
+      @quantity = quantity unless quantity == SKIP
+      @shipping_amount = shipping_amount unless shipping_amount == SKIP
+      @subscriber = subscriber unless subscriber == SKIP
+      @auto_renewal = auto_renewal unless auto_renewal == SKIP
+      @application_context = application_context unless application_context == SKIP
+      @custom_id = custom_id unless custom_id == SKIP
+      @plan = plan unless plan == 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.
+      plan_id = hash.key?('plan_id') ? hash['plan_id'] : nil
+      start_time = hash.key?('start_time') ? hash['start_time'] : SKIP
+      quantity = hash.key?('quantity') ? hash['quantity'] : SKIP
+      shipping_amount = Money.from_hash(hash['shipping_amount']) if hash['shipping_amount']
+      subscriber = SubscriberRequest.from_hash(hash['subscriber']) if hash['subscriber']
+      auto_renewal = hash['auto_renewal'] ||= false
+      application_context = SubscriptionApplicationContext.from_hash(hash['application_context']) if
+        hash['application_context']
+      custom_id = hash.key?('custom_id') ? hash['custom_id'] : SKIP
+      plan = PlanOverride.from_hash(hash['plan']) if hash['plan']
+
+      # Create object from extracted values.
+      CreateSubscriptionRequest.new(plan_id: plan_id,
+                                    start_time: start_time,
+                                    quantity: quantity,
+                                    shipping_amount: shipping_amount,
+                                    subscriber: subscriber,
+                                    auto_renewal: auto_renewal,
+                                    application_context: application_context,
+                                    custom_id: custom_id,
+                                    plan: plan)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} plan_id: #{@plan_id}, start_time: #{@start_time}, quantity: #{@quantity},"\
+      " shipping_amount: #{@shipping_amount}, subscriber: #{@subscriber}, auto_renewal:"\
+      " #{@auto_renewal}, application_context: #{@application_context}, custom_id: #{@custom_id},"\
+      " plan: #{@plan}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} plan_id: #{@plan_id.inspect}, start_time: #{@start_time.inspect}, quantity:"\
+      " #{@quantity.inspect}, shipping_amount: #{@shipping_amount.inspect}, subscriber:"\
+      " #{@subscriber.inspect}, auto_renewal: #{@auto_renewal.inspect}, application_context:"\
+      " #{@application_context.inspect}, custom_id: #{@custom_id.inspect}, plan:"\
+      " #{@plan.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/customer.rb

@@ -0,0 +1,76 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # This object defines a customer in your system. Use it to manage customer
+  # profiles, save payment methods and contact details.
+  class Customer < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique ID for a customer generated by PayPal.
+    # @return [String]
+    attr_accessor :id
+
+    # Merchants and partners may already have a data-store where their customer
+    # information is persisted. Use merchant_customer_id to associate the
+    # PayPal-generated customer.id to your representation of a customer.
+    # @return [String]
+    attr_accessor :merchant_customer_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['merchant_customer_id'] = 'merchant_customer_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        merchant_customer_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, merchant_customer_id: SKIP)
+      @id = id unless id == SKIP
+      @merchant_customer_id = merchant_customer_id unless merchant_customer_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.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      merchant_customer_id =
+        hash.key?('merchant_customer_id') ? hash['merchant_customer_id'] : SKIP
+
+      # Create object from extracted values.
+      Customer.new(id: id,
+                   merchant_customer_id: merchant_customer_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, merchant_customer_id: #{@merchant_customer_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, merchant_customer_id:"\
+      " #{@merchant_customer_id.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/customer_information.rb

@@ -0,0 +1,95 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # This object represents a merchant’s customer, allowing them to store contact
+  # details, and track all payments associated with the same customer.
+  class CustomerInformation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique ID for a customer generated by PayPal.
+    # @return [String]
+    attr_accessor :id
+
+    # 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 information.
+    # @return [PhoneWithType]
+    attr_accessor :phone
+
+    # The name of the party.
+    # @return [Name]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['email_address'] = 'email_address'
+      @_hash['phone'] = 'phone'
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        email_address
+        phone
+        name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, email_address: SKIP, phone: SKIP, name: SKIP)
+      @id = id unless id == SKIP
+      @email_address = email_address unless email_address == SKIP
+      @phone = phone unless phone == SKIP
+      @name = name unless 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.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      email_address = hash.key?('email_address') ? hash['email_address'] : SKIP
+      phone = PhoneWithType.from_hash(hash['phone']) if hash['phone']
+      name = Name.from_hash(hash['name']) if hash['name']
+
+      # Create object from extracted values.
+      CustomerInformation.new(id: id,
+                              email_address: email_address,
+                              phone: phone,
+                              name: name)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, email_address: #{@email_address}, phone: #{@phone}, name:"\
+      " #{@name}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, email_address: #{@email_address.inspect}, phone:"\
+      " #{@phone.inspect}, name: #{@name.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/customer_response.rb

@@ -0,0 +1,75 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Customer in merchant's or partner's system of records.
+  class CustomerResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique ID for a customer generated by PayPal.
+    # @return [String]
+    attr_accessor :id
+
+    # Merchants and partners may already have a data-store where their customer
+    # information is persisted. Use merchant_customer_id to associate the
+    # PayPal-generated customer.id to your representation of a customer.
+    # @return [String]
+    attr_accessor :merchant_customer_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['merchant_customer_id'] = 'merchant_customer_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        merchant_customer_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, merchant_customer_id: SKIP)
+      @id = id unless id == SKIP
+      @merchant_customer_id = merchant_customer_id unless merchant_customer_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.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      merchant_customer_id =
+        hash.key?('merchant_customer_id') ? hash['merchant_customer_id'] : SKIP
+
+      # Create object from extracted values.
+      CustomerResponse.new(id: id,
+                           merchant_customer_id: merchant_customer_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, merchant_customer_id: #{@merchant_customer_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, merchant_customer_id:"\
+      " #{@merchant_customer_id.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/customer_vault_payment_tokens_response.rb

@@ -0,0 +1,123 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Collection of payment tokens saved for a given customer.
+  class CustomerVaultPaymentTokensResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Total number of items.
+    # @return [Integer]
+    attr_accessor :total_items
+
+    # Total number of pages.
+    # @return [Integer]
+    attr_accessor :total_pages
+
+    # This object defines a customer in your system. Use it to manage customer
+    # profiles, save payment methods and contact details.
+    # @return [VaultResponseCustomer]
+    attr_accessor :customer
+
+    # This object defines a customer in your system. Use it to manage customer
+    # profiles, save payment methods and contact details.
+    # @return [Array[PaymentTokenResponse]]
+    attr_accessor :payment_tokens
+
+    # An array of related [HATEOAS
+    # links](https://developer.paypal.com/api/rest/responses/#hateoas).
+    # @return [Array[LinkDescription]]
+    attr_accessor :links
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['total_items'] = 'total_items'
+      @_hash['total_pages'] = 'total_pages'
+      @_hash['customer'] = 'customer'
+      @_hash['payment_tokens'] = 'payment_tokens'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        total_items
+        total_pages
+        customer
+        payment_tokens
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(total_items: SKIP, total_pages: SKIP, customer: SKIP,
+                   payment_tokens: SKIP, links: SKIP)
+      @total_items = total_items unless total_items == SKIP
+      @total_pages = total_pages unless total_pages == SKIP
+      @customer = customer unless customer == SKIP
+      @payment_tokens = payment_tokens unless payment_tokens == 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.
+      total_items = hash.key?('total_items') ? hash['total_items'] : SKIP
+      total_pages = hash.key?('total_pages') ? hash['total_pages'] : SKIP
+      customer = VaultResponseCustomer.from_hash(hash['customer']) if hash['customer']
+      # Parameter is an array, so we need to iterate through it
+      payment_tokens = nil
+      unless hash['payment_tokens'].nil?
+        payment_tokens = []
+        hash['payment_tokens'].each do |structure|
+          payment_tokens << (PaymentTokenResponse.from_hash(structure) if structure)
+        end
+      end
+
+      payment_tokens = SKIP unless hash.key?('payment_tokens')
+      # 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.
+      CustomerVaultPaymentTokensResponse.new(total_items: total_items,
+                                             total_pages: total_pages,
+                                             customer: customer,
+                                             payment_tokens: payment_tokens,
+                                             links: links)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} total_items: #{@total_items}, total_pages: #{@total_pages}, customer:"\
+      " #{@customer}, payment_tokens: #{@payment_tokens}, links: #{@links}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} total_items: #{@total_items.inspect}, total_pages: #{@total_pages.inspect},"\
+      " customer: #{@customer.inspect}, payment_tokens: #{@payment_tokens.inspect}, links:"\
+      " #{@links.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/cvv_code.rb

@@ -0,0 +1,93 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The card verification value code for for Visa, Discover, Mastercard, or
+  # American Express.
+  class CvvCode
+    CVV_CODE = [
+      # For Visa, Mastercard, Discover, or American Express, error -
+      # unrecognized or unknown response.
+      CVV_E = 'E'.freeze,
+
+      # For Visa, Mastercard, Discover, or American Express, invalid or null.
+      CVV_I = 'I'.freeze,
+
+      # For Visa, Mastercard, Discover, or American Express, the CVV2/CSC
+      # matches.
+      CVV_M = 'M'.freeze,
+
+      # For Visa, Mastercard, Discover, or American Express, the CVV2/CSC does
+      # not match.
+      CVV_N = 'N'.freeze,
+
+      # For Visa, Mastercard, Discover, or American Express, it was not
+      # processed.
+      CVV_P = 'P'.freeze,
+
+      # For Visa, Mastercard, Discover, or American Express, the service is not
+      # supported.
+      CVV_S = 'S'.freeze,
+
+      # For Visa, Mastercard, Discover, or American Express, unknown - the
+      # issuer is not certified.
+      CVV_U = 'U'.freeze,
+
+      # For Visa, Mastercard, Discover, or American Express, no response. For
+      # Maestro, the service is not available.
+      CVV_X = 'X'.freeze,
+
+      # For Visa, Mastercard, Discover, or American Express, error.
+      ENUM_ALL_OTHERS = 'All others'.freeze,
+
+      # For Maestro, the CVV2 matched.
+      CVV_0 = '0'.freeze,
+
+      # For Maestro, the CVV2 did not match.
+      CVV_1 = '1'.freeze,
+
+      # For Maestro, the merchant has not implemented CVV2 code handling.
+      CVV_2 = '2'.freeze,
+
+      # For Maestro, the merchant has indicated that CVV2 is not present on
+      # card.
+      CVV_3 = '3'.freeze,
+
+      # For Maestro, the service is not available.
+      CVV_4 = '4'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CVV_E)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'cvv_e' then CVV_E
+      when 'cvv_i' then CVV_I
+      when 'cvv_m' then CVV_M
+      when 'cvv_n' then CVV_N
+      when 'cvv_p' then CVV_P
+      when 'cvv_s' then CVV_S
+      when 'cvv_u' then CVV_U
+      when 'cvv_x' then CVV_X
+      when 'enum_all_others' then ENUM_ALL_OTHERS
+      when 'cvv_0' then CVV_0
+      when 'cvv_1' then CVV_1
+      when 'cvv_2' then CVV_2
+      when 'cvv_3' then CVV_3
+      when 'cvv_4' then CVV_4
+      else
+        default_value
+      end
+    end
+  end
+end