paypal-server-sdk 1.1.0 → 2.0.0

data/lib/paypal_server_sdk/models/subscription_collection.rb

@@ -0,0 +1,90 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The list of subscriptions.
+  class SubscriptionCollection < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of subscriptions.
+    # @return [Array[Subscription]]
+    attr_accessor :subscriptions
+
+    # An array of request-related [HATEOAS
+    # links](/docs/api/reference/api-responses/#hateoas-links).
+    # @return [Array[LinkDescription]]
+    attr_accessor :links
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['subscriptions'] = 'subscriptions'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        subscriptions
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(subscriptions: SKIP, links: SKIP)
+      @subscriptions = subscriptions unless subscriptions == 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.
+      # Parameter is an array, so we need to iterate through it
+      subscriptions = nil
+      unless hash['subscriptions'].nil?
+        subscriptions = []
+        hash['subscriptions'].each do |structure|
+          subscriptions << (Subscription.from_hash(structure) if structure)
+        end
+      end
+
+      subscriptions = SKIP unless hash.key?('subscriptions')
+      # 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.
+      SubscriptionCollection.new(subscriptions: subscriptions,
+                                 links: links)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} subscriptions: #{@subscriptions}, links: #{@links}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} subscriptions: #{@subscriptions.inspect}, links: #{@links.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/subscription_customer_information.rb

@@ -0,0 +1,84 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The details about a customer in PayPal's system of record.
+  class SubscriptionCustomerInformation < 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
+
+    # 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
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        email_address
+        phone
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, email_address: SKIP, phone: SKIP)
+      @id = id unless id == SKIP
+      @email_address = email_address unless email_address == SKIP
+      @phone = phone unless phone == 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']
+
+      # Create object from extracted values.
+      SubscriptionCustomerInformation.new(id: id,
+                                          email_address: email_address,
+                                          phone: phone)
+    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}>"
+    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}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/subscription_patch_application_context.rb

@@ -0,0 +1,122 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The application context, which customizes the payer experience during the
+  # subscription approval process with PayPal.
+  class SubscriptionPatchApplicationContext < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The label that overrides the business name in the PayPal account on the
+    # PayPal site.
+    # @return [String]
+    attr_accessor :brand_name
+
+    # The BCP 47-formatted locale of pages that the PayPal payment experience
+    # shows. PayPal supports a five-character code. For example, `da-DK`,
+    # `he-IL`, `id-ID`, `ja-JP`, `no-NO`, `pt-BR`, `ru-RU`, `sv-SE`, `th-TH`,
+    # `zh-CN`, `zh-HK`, or `zh-TW`.
+    # @return [String]
+    attr_accessor :locale
+
+    # The location from which the shipping address is derived.
+    # @return [ExperienceContextShippingPreference]
+    attr_accessor :shipping_preference
+
+    # The customer and merchant payment preferences.
+    # @return [PaymentMethod]
+    attr_accessor :payment_method
+
+    # The URL where the customer is redirected after the customer approves the
+    # payment.
+    # @return [String]
+    attr_accessor :return_url
+
+    # The URL where the customer is redirected after the customer cancels the
+    # payment.
+    # @return [String]
+    attr_accessor :cancel_url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['brand_name'] = 'brand_name'
+      @_hash['locale'] = 'locale'
+      @_hash['shipping_preference'] = 'shipping_preference'
+      @_hash['payment_method'] = 'payment_method'
+      @_hash['return_url'] = 'return_url'
+      @_hash['cancel_url'] = 'cancel_url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        brand_name
+        locale
+        shipping_preference
+        payment_method
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(
+      return_url:, cancel_url:, brand_name: SKIP, locale: SKIP,
+      shipping_preference: ExperienceContextShippingPreference::GET_FROM_FILE,
+      payment_method: SKIP
+    )
+      @brand_name = brand_name unless brand_name == SKIP
+      @locale = locale unless locale == SKIP
+      @shipping_preference = shipping_preference unless shipping_preference == SKIP
+      @payment_method = payment_method unless payment_method == SKIP
+      @return_url = return_url
+      @cancel_url = cancel_url
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      return_url = hash.key?('return_url') ? hash['return_url'] : nil
+      cancel_url = hash.key?('cancel_url') ? hash['cancel_url'] : nil
+      brand_name = hash.key?('brand_name') ? hash['brand_name'] : SKIP
+      locale = hash.key?('locale') ? hash['locale'] : SKIP
+      shipping_preference =
+        hash['shipping_preference'] ||= ExperienceContextShippingPreference::GET_FROM_FILE
+      payment_method = PaymentMethod.from_hash(hash['payment_method']) if hash['payment_method']
+
+      # Create object from extracted values.
+      SubscriptionPatchApplicationContext.new(return_url: return_url,
+                                              cancel_url: cancel_url,
+                                              brand_name: brand_name,
+                                              locale: locale,
+                                              shipping_preference: shipping_preference,
+                                              payment_method: payment_method)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} brand_name: #{@brand_name}, locale: #{@locale}, shipping_preference:"\
+      " #{@shipping_preference}, payment_method: #{@payment_method}, return_url: #{@return_url},"\
+      " cancel_url: #{@cancel_url}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} brand_name: #{@brand_name.inspect}, locale: #{@locale.inspect},"\
+      " shipping_preference: #{@shipping_preference.inspect}, payment_method:"\
+      " #{@payment_method.inspect}, return_url: #{@return_url.inspect}, cancel_url:"\
+      " #{@cancel_url.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/subscription_payer_name.rb

@@ -0,0 +1,114 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The name of the party.
+  class SubscriptionPayerName < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The prefix, or title, to the party's name.
+    # @return [String]
+    attr_accessor :prefix
+
+    # When the party is a person, the party's given, or first, name.
+    # @return [String]
+    attr_accessor :given_name
+
+    # When the party is a person, the party's surname or family name. Also known
+    # as the last name. Required when the party is a person. Use also to store
+    # multiple surnames including the matronymic, or mother's, surname.
+    # @return [String]
+    attr_accessor :surname
+
+    # When the party is a person, the party's middle name. Use also to store
+    # multiple middle names including the patronymic, or father's, middle name.
+    # @return [String]
+    attr_accessor :middle_name
+
+    # The suffix for the party's name.
+    # @return [String]
+    attr_accessor :suffix
+
+    # 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['prefix'] = 'prefix'
+      @_hash['given_name'] = 'given_name'
+      @_hash['surname'] = 'surname'
+      @_hash['middle_name'] = 'middle_name'
+      @_hash['suffix'] = 'suffix'
+      @_hash['full_name'] = 'full_name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        prefix
+        given_name
+        surname
+        middle_name
+        suffix
+        full_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(prefix: SKIP, given_name: SKIP, surname: SKIP,
+                   middle_name: SKIP, suffix: SKIP, full_name: SKIP)
+      @prefix = prefix unless prefix == SKIP
+      @given_name = given_name unless given_name == SKIP
+      @surname = surname unless surname == SKIP
+      @middle_name = middle_name unless middle_name == SKIP
+      @suffix = suffix unless suffix == 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.
+      prefix = hash.key?('prefix') ? hash['prefix'] : SKIP
+      given_name = hash.key?('given_name') ? hash['given_name'] : SKIP
+      surname = hash.key?('surname') ? hash['surname'] : SKIP
+      middle_name = hash.key?('middle_name') ? hash['middle_name'] : SKIP
+      suffix = hash.key?('suffix') ? hash['suffix'] : SKIP
+      full_name = hash.key?('full_name') ? hash['full_name'] : SKIP
+
+      # Create object from extracted values.
+      SubscriptionPayerName.new(prefix: prefix,
+                                given_name: given_name,
+                                surname: surname,
+                                middle_name: middle_name,
+                                suffix: suffix,
+                                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} prefix: #{@prefix}, given_name: #{@given_name}, surname: #{@surname},"\
+      " middle_name: #{@middle_name}, suffix: #{@suffix}, 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} prefix: #{@prefix.inspect}, given_name: #{@given_name.inspect}, surname:"\
+      " #{@surname.inspect}, middle_name: #{@middle_name.inspect}, suffix: #{@suffix.inspect},"\
+      " full_name: #{@full_name.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/subscription_payment_source.rb

@@ -0,0 +1,65 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The payment source definition. To be eligible to create subscription using
+  # debit or credit card, you will need to sign up here
+  # (https://www.paypal.com/bizsignup/entry/product/ppcp). Please note, its
+  # available only for non-3DS cards and for merchants in US and AU regions.
+  class SubscriptionPaymentSource < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The payment card to use to fund a payment. Can be a credit or debit card.
+    # @return [SubscriptionCardRequest]
+    attr_accessor :card
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['card'] = 'card'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        card
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(card: SKIP)
+      @card = card unless card == 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.
+      card = SubscriptionCardRequest.from_hash(hash['card']) if hash['card']
+
+      # Create object from extracted values.
+      SubscriptionPaymentSource.new(card: card)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} card: #{@card}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} card: #{@card.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/subscription_payment_source_response.rb

@@ -0,0 +1,63 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The payment source used to fund the payment.
+  class SubscriptionPaymentSourceResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The payment card used to fund the payment. Card can be a credit or debit
+    # card.
+    # @return [CardResponseWithBillingAddress]
+    attr_accessor :card
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['card'] = 'card'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        card
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(card: SKIP)
+      @card = card unless card == 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.
+      card = CardResponseWithBillingAddress.from_hash(hash['card']) if hash['card']
+
+      # Create object from extracted values.
+      SubscriptionPaymentSourceResponse.new(card: card)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} card: #{@card}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} card: #{@card.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/subscription_plan_status.rb

@@ -0,0 +1,28 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The plan status.
+  class SubscriptionPlanStatus
+    SUBSCRIPTION_PLAN_STATUS = [
+      # The plan was created. You cannot create subscriptions for a plan in this
+      # state.
+      CREATED = 'CREATED'.freeze,
+
+      # The plan is inactive.
+      INACTIVE = 'INACTIVE'.freeze,
+
+      # The plan is active. You can only create subscriptions for a plan in this
+      # state.
+      ACTIVE = 'ACTIVE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/subscription_pricing_model.rb

@@ -0,0 +1,23 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The pricing model for tiered plan. The `tiers` parameter is required.
+  class SubscriptionPricingModel
+    SUBSCRIPTION_PRICING_MODEL = [
+      # A volume pricing model.
+      VOLUME = 'VOLUME'.freeze,
+
+      # A tiered pricing model.
+      TIERED = 'TIERED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end