paypal-server-sdk 1.0.0 → 2.0.0

data/lib/paypal_server_sdk/models/paypal_wallet_vault_instruction.rb

@@ -1,18 +1,15 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
-  # PaypalWalletVaultInstruction Model.
+  # Resource consolidating common request and response attributes for vaulting
+  # PayPal Wallet.
   class PaypalWalletVaultInstruction < BaseModel
     SKIP = Object.new
     private_constant :SKIP
 
-    # Defines how and when the payment source gets vaulted.
-    # @return [StoreInVaultInstruction]
-    attr_accessor :store_in_vault
-
     # The description displayed to PayPal consumer on the approval flow for
     # PayPal, as well as on the PayPal payment token management experience on
     # PayPal.com.
@@ -47,7 +44,6 @@ module PaypalServerSdk
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
-      @_hash['store_in_vault'] = 'store_in_vault'
       @_hash['description'] = 'description'
       @_hash['usage_pattern'] = 'usage_pattern'
       @_hash['usage_type'] = 'usage_type'
@@ -60,7 +56,6 @@ module PaypalServerSdk
     # An array for optional fields
     def self.optionals
       %w[
-        store_in_vault
         description
         usage_pattern
         customer_type
@@ -73,11 +68,9 @@ module PaypalServerSdk
       []
     end
 
-    def initialize(usage_type:, store_in_vault: SKIP, description: SKIP,
-                   usage_pattern: SKIP,
+    def initialize(usage_type:, description: SKIP, usage_pattern: SKIP,
                    customer_type: PaypalPaymentTokenCustomerType::CONSUMER,
                    permit_multiple_payment_tokens: false)
-      @store_in_vault = store_in_vault unless store_in_vault == SKIP
       @description = description unless description == SKIP
       @usage_pattern = usage_pattern unless usage_pattern == SKIP
       @usage_type = usage_type
@@ -94,8 +87,6 @@ module PaypalServerSdk
 
       # Extract variables from the hash.
       usage_type = hash.key?('usage_type') ? hash['usage_type'] : nil
-      store_in_vault =
-        hash.key?('store_in_vault') ? hash['store_in_vault'] : SKIP
       description = hash.key?('description') ? hash['description'] : SKIP
       usage_pattern = hash.key?('usage_pattern') ? hash['usage_pattern'] : SKIP
       customer_type =
@@ -105,7 +96,6 @@ module PaypalServerSdk
 
       # Create object from extracted values.
       PaypalWalletVaultInstruction.new(usage_type: usage_type,
-                                       store_in_vault: store_in_vault,
                                        description: description,
                                        usage_pattern: usage_pattern,
                                        customer_type: customer_type,
@@ -115,18 +105,18 @@ module PaypalServerSdk
     # Provides a human-readable string representation of the object.
     def to_s
       class_name = self.class.name.split('::').last
-      "<#{class_name} store_in_vault: #{@store_in_vault}, description: #{@description},"\
-      " usage_pattern: #{@usage_pattern}, usage_type: #{@usage_type}, customer_type:"\
-      " #{@customer_type}, permit_multiple_payment_tokens: #{@permit_multiple_payment_tokens}>"
+      "<#{class_name} description: #{@description}, usage_pattern: #{@usage_pattern}, usage_type:"\
+      " #{@usage_type}, customer_type: #{@customer_type}, permit_multiple_payment_tokens:"\
+      " #{@permit_multiple_payment_tokens}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
     def inspect
       class_name = self.class.name.split('::').last
-      "<#{class_name} store_in_vault: #{@store_in_vault.inspect}, description:"\
-      " #{@description.inspect}, usage_pattern: #{@usage_pattern.inspect}, usage_type:"\
-      " #{@usage_type.inspect}, customer_type: #{@customer_type.inspect},"\
-      " permit_multiple_payment_tokens: #{@permit_multiple_payment_tokens.inspect}>"
+      "<#{class_name} description: #{@description.inspect}, usage_pattern:"\
+      " #{@usage_pattern.inspect}, usage_type: #{@usage_type.inspect}, customer_type:"\
+      " #{@customer_type.inspect}, permit_multiple_payment_tokens:"\
+      " #{@permit_multiple_payment_tokens.inspect}>"
     end
   end
 end

data/lib/paypal_server_sdk/models/paypal_wallet_vault_response.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # The details about a saved PayPal Wallet payment source.

data/lib/paypal_server_sdk/models/paypal_wallet_vault_status.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # The vault status.

data/lib/paypal_server_sdk/models/phone.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # The phone number, in its canonical international [E.164 numbering plan

data/lib/paypal_server_sdk/models/phone_number.rb

@@ -1,10 +1,12 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # The phone number in its canonical international [E.164 numbering plan
+  # format](https://www.itu.int/rec/T-REC-E.164/en)., The phone number, in its
+  # canonical international [E.164 numbering plan
   # format](https://www.itu.int/rec/T-REC-E.164/en).
   class PhoneNumber < BaseModel
     SKIP = Object.new

data/lib/paypal_server_sdk/models/phone_number_with_country_code.rb

@@ -1,12 +1,14 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # The phone number in its canonical international [E.164 numbering plan
   # format](https://www.itu.int/rec/T-REC-E.164/en)., The phone number, in its
   # canonical international [E.164 numbering plan
+  # format](https://www.itu.int/rec/T-REC-E.164/en)., The phone number, in its
+  # canonical international [E.164 numbering plan
   # format](https://www.itu.int/rec/T-REC-E.164/en).
   class PhoneNumberWithCountryCode < BaseModel
     SKIP = Object.new

data/lib/paypal_server_sdk/models/phone_number_with_optional_country_code.rb

@@ -0,0 +1,81 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The phone number in its canonical international [E.164 numbering plan
+  # format](https://www.itu.int/rec/T-REC-E.164/en).
+  class PhoneNumberWithOptionalCountryCode < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The country calling code (CC), in its canonical international [E.164
+    # numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The
+    # combined length of the CC and the national number must not be greater than
+    # 15 digits. The national number consists of a national destination code
+    # (NDC) and subscriber number (SN).
+    # @return [String]
+    attr_accessor :country_code
+
+    # The national number, in its canonical international [E.164 numbering plan
+    # format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of
+    # the country calling code (CC) and the national number must not be greater
+    # than 15 digits. The national number consists of a national destination
+    # code (NDC) and subscriber number (SN).
+    # @return [String]
+    attr_accessor :national_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['country_code'] = 'country_code'
+      @_hash['national_number'] = 'national_number'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        country_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(national_number:, country_code: SKIP)
+      @country_code = country_code unless country_code == SKIP
+      @national_number = national_number
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      national_number =
+        hash.key?('national_number') ? hash['national_number'] : nil
+      country_code = hash.key?('country_code') ? hash['country_code'] : SKIP
+
+      # Create object from extracted values.
+      PhoneNumberWithOptionalCountryCode.new(national_number: national_number,
+                                             country_code: country_code)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} country_code: #{@country_code}, national_number: #{@national_number}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} country_code: #{@country_code.inspect}, national_number:"\
+      " #{@national_number.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/phone_type.rb

@@ -1,25 +1,25 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # The phone type.
   class PhoneType
     PHONE_TYPE = [
-      # TODO: Write general description for FAX
+      # Fax number.
       FAX = 'FAX'.freeze,
 
-      # TODO: Write general description for HOME
+      # Home phone number.
       HOME = 'HOME'.freeze,
 
-      # TODO: Write general description for MOBILE
+      # Mobile phone number.
       MOBILE = 'MOBILE'.freeze,
 
-      # TODO: Write general description for OTHER
+      # Other phone number.
       OTHER = 'OTHER'.freeze,
 
-      # TODO: Write general description for PAGER
+      # Pager number.
       PAGER = 'PAGER'.freeze
     ].freeze
 

data/lib/paypal_server_sdk/models/phone_with_type.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # The phone information.

data/lib/paypal_server_sdk/models/plan.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # The merchant level Recurring Billing plan metadata for the Billing
@@ -15,10 +15,6 @@ module PaypalServerSdk
     # @return [Array[BillingCycle]]
     attr_accessor :billing_cycles
 
-    # Product details associated with any one-time product purchase.
-    # @return [Object]
-    attr_accessor :product
-
     # The one-time charge info at the time of checkout.
     # @return [OneTimeCharge]
     attr_accessor :one_time_charges
@@ -31,7 +27,6 @@ module PaypalServerSdk
     def self.names
       @_hash = {} if @_hash.nil?
       @_hash['billing_cycles'] = 'billing_cycles'
-      @_hash['product'] = 'product'
       @_hash['one_time_charges'] = 'one_time_charges'
       @_hash['name'] = 'name'
       @_hash
@@ -40,7 +35,6 @@ module PaypalServerSdk
     # An array for optional fields
     def self.optionals
       %w[
-        product
         name
       ]
     end
@@ -50,10 +44,8 @@ module PaypalServerSdk
       []
     end
 
-    def initialize(billing_cycles:, one_time_charges:, product: SKIP,
-                   name: SKIP)
+    def initialize(billing_cycles:, one_time_charges:, name: SKIP)
       @billing_cycles = billing_cycles
-      @product = product unless product == SKIP
       @one_time_charges = one_time_charges
       @name = name unless name == SKIP
     end
@@ -75,28 +67,26 @@ module PaypalServerSdk
       billing_cycles = nil unless hash.key?('billing_cycles')
       one_time_charges = OneTimeCharge.from_hash(hash['one_time_charges']) if
         hash['one_time_charges']
-      product = hash.key?('product') ? hash['product'] : SKIP
       name = hash.key?('name') ? hash['name'] : SKIP
 
       # Create object from extracted values.
       Plan.new(billing_cycles: billing_cycles,
                one_time_charges: one_time_charges,
-               product: product,
                name: name)
     end
 
     # Provides a human-readable string representation of the object.
     def to_s
       class_name = self.class.name.split('::').last
-      "<#{class_name} billing_cycles: #{@billing_cycles}, product: #{@product}, one_time_charges:"\
-      " #{@one_time_charges}, name: #{@name}>"
+      "<#{class_name} billing_cycles: #{@billing_cycles}, one_time_charges: #{@one_time_charges},"\
+      " name: #{@name}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
     def inspect
       class_name = self.class.name.split('::').last
-      "<#{class_name} billing_cycles: #{@billing_cycles.inspect}, product: #{@product.inspect},"\
-      " one_time_charges: #{@one_time_charges.inspect}, name: #{@name.inspect}>"
+      "<#{class_name} billing_cycles: #{@billing_cycles.inspect}, one_time_charges:"\
+      " #{@one_time_charges.inspect}, name: #{@name.inspect}>"
     end
   end
 end

data/lib/paypal_server_sdk/models/plan_collection.rb

@@ -0,0 +1,111 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The list of plans with details.
+  class PlanCollection < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of plans.
+    # @return [Array[BillingPlan]]
+    attr_accessor :plans
+
+    # The total number of items.
+    # @return [Integer]
+    attr_accessor :total_items
+
+    # The total number of pages.
+    # @return [Integer]
+    attr_accessor :total_pages
+
+    # 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['plans'] = 'plans'
+      @_hash['total_items'] = 'total_items'
+      @_hash['total_pages'] = 'total_pages'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        plans
+        total_items
+        total_pages
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(plans: SKIP, total_items: SKIP, total_pages: SKIP,
+                   links: SKIP)
+      @plans = plans unless plans == SKIP
+      @total_items = total_items unless total_items == SKIP
+      @total_pages = total_pages unless total_pages == 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
+      plans = nil
+      unless hash['plans'].nil?
+        plans = []
+        hash['plans'].each do |structure|
+          plans << (BillingPlan.from_hash(structure) if structure)
+        end
+      end
+
+      plans = SKIP unless hash.key?('plans')
+      total_items = hash.key?('total_items') ? hash['total_items'] : SKIP
+      total_pages = hash.key?('total_pages') ? hash['total_pages'] : 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.
+      PlanCollection.new(plans: plans,
+                         total_items: total_items,
+                         total_pages: total_pages,
+                         links: links)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} plans: #{@plans}, total_items: #{@total_items}, total_pages:"\
+      " #{@total_pages}, links: #{@links}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} plans: #{@plans.inspect}, total_items: #{@total_items.inspect},"\
+      " total_pages: #{@total_pages.inspect}, links: #{@links.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/plan_details.rb

@@ -0,0 +1,147 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The plan details.
+  class PlanDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID for the product.
+    # @return [String]
+    attr_accessor :product_id
+
+    # The plan name.
+    # @return [String]
+    attr_accessor :name
+
+    # The detailed description of the plan.
+    # @return [String]
+    attr_accessor :description
+
+    # An array of billing cycles for trial billing and regular billing. A plan
+    # can have at most two trial cycles and only one regular cycle.
+    # @return [Array[SubscriptionBillingCycle]]
+    attr_accessor :billing_cycles
+
+    # The payment preferences for a subscription.
+    # @return [PaymentPreferences]
+    attr_accessor :payment_preferences
+
+    # The merchant preferences for a subscription.
+    # @return [MerchantPreferences]
+    attr_accessor :merchant_preferences
+
+    # The tax details.
+    # @return [Taxes]
+    attr_accessor :taxes
+
+    # Indicates whether you can subscribe to this plan by providing a quantity
+    # for the goods or service.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :quantity_supported
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['product_id'] = 'product_id'
+      @_hash['name'] = 'name'
+      @_hash['description'] = 'description'
+      @_hash['billing_cycles'] = 'billing_cycles'
+      @_hash['payment_preferences'] = 'payment_preferences'
+      @_hash['merchant_preferences'] = 'merchant_preferences'
+      @_hash['taxes'] = 'taxes'
+      @_hash['quantity_supported'] = 'quantity_supported'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        product_id
+        name
+        description
+        billing_cycles
+        payment_preferences
+        merchant_preferences
+        taxes
+        quantity_supported
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(product_id: SKIP, name: SKIP, description: SKIP,
+                   billing_cycles: SKIP, payment_preferences: SKIP,
+                   merchant_preferences: SKIP, taxes: SKIP,
+                   quantity_supported: false)
+      @product_id = product_id unless product_id == SKIP
+      @name = name unless name == SKIP
+      @description = description unless description == SKIP
+      @billing_cycles = billing_cycles unless billing_cycles == SKIP
+      @payment_preferences = payment_preferences unless payment_preferences == SKIP
+      @merchant_preferences = merchant_preferences unless merchant_preferences == SKIP
+      @taxes = taxes unless taxes == SKIP
+      @quantity_supported = quantity_supported unless quantity_supported == 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.
+      product_id = hash.key?('product_id') ? hash['product_id'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      billing_cycles = nil
+      unless hash['billing_cycles'].nil?
+        billing_cycles = []
+        hash['billing_cycles'].each do |structure|
+          billing_cycles << (SubscriptionBillingCycle.from_hash(structure) if structure)
+        end
+      end
+
+      billing_cycles = SKIP unless hash.key?('billing_cycles')
+      payment_preferences = PaymentPreferences.from_hash(hash['payment_preferences']) if
+        hash['payment_preferences']
+      merchant_preferences = MerchantPreferences.from_hash(hash['merchant_preferences']) if
+        hash['merchant_preferences']
+      taxes = Taxes.from_hash(hash['taxes']) if hash['taxes']
+      quantity_supported = hash['quantity_supported'] ||= false
+
+      # Create object from extracted values.
+      PlanDetails.new(product_id: product_id,
+                      name: name,
+                      description: description,
+                      billing_cycles: billing_cycles,
+                      payment_preferences: payment_preferences,
+                      merchant_preferences: merchant_preferences,
+                      taxes: taxes,
+                      quantity_supported: quantity_supported)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} product_id: #{@product_id}, name: #{@name}, description: #{@description},"\
+      " billing_cycles: #{@billing_cycles}, payment_preferences: #{@payment_preferences},"\
+      " merchant_preferences: #{@merchant_preferences}, taxes: #{@taxes}, quantity_supported:"\
+      " #{@quantity_supported}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} product_id: #{@product_id.inspect}, name: #{@name.inspect}, description:"\
+      " #{@description.inspect}, billing_cycles: #{@billing_cycles.inspect}, payment_preferences:"\
+      " #{@payment_preferences.inspect}, merchant_preferences: #{@merchant_preferences.inspect},"\
+      " taxes: #{@taxes.inspect}, quantity_supported: #{@quantity_supported.inspect}>"
+    end
+  end
+end