cli-sdk 1.0.0 → 10.0.1

data/lib/paypal_server_sdk/models/paypal_wallet_vault_status.rb

@@ -0,0 +1,45 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The vault status.
+  class PaypalWalletVaultStatus
+    PAYPAL_WALLET_VAULT_STATUS = [
+      # The payment source has been saved in your customer's vault. This vault
+      # status reflects `/v3/vault` status.
+      VAULTED = 'VAULTED'.freeze,
+
+      # DEPRECATED. The payment source has been saved in your customer's vault.
+      # This status applies to deprecated integration patterns and will not be
+      # returned for v3/vault integrations.
+      CREATED = 'CREATED'.freeze,
+
+      # Customer has approved the action of saving the specified payment_source
+      # into their vault. Use v3/vault/payment-tokens with given setup_token to
+      # save the payment source in the vault
+      APPROVED = 'APPROVED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = VAULTED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'vaulted' then VAULTED
+      when 'created' then CREATED
+      when 'approved' then APPROVED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/phone.rb

@@ -0,0 +1,91 @@
+# 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 Phone < 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
+
+    # The extension number.
+    # @return [String]
+    attr_accessor :extension_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['extension_number'] = 'extension_number'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        extension_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(country_code:, national_number:, extension_number: SKIP)
+      @country_code = country_code
+      @national_number = national_number
+      @extension_number = extension_number unless extension_number == 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.
+      country_code = hash.key?('country_code') ? hash['country_code'] : nil
+      national_number =
+        hash.key?('national_number') ? hash['national_number'] : nil
+      extension_number =
+        hash.key?('extension_number') ? hash['extension_number'] : SKIP
+
+      # Create object from extracted values.
+      Phone.new(country_code: country_code,
+                national_number: national_number,
+                extension_number: extension_number)
+    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},"\
+      " extension_number: #{@extension_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}, extension_number: #{@extension_number.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/phone_number.rb

@@ -0,0 +1,68 @@
+# 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)., 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
+    private_constant :SKIP
+
+    # 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['national_number'] = 'national_number'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(national_number:)
+      @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
+
+      # Create object from extracted values.
+      PhoneNumber.new(national_number: national_number)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} 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} national_number: #{@national_number.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/phone_number_with_country_code.rb

@@ -0,0 +1,83 @@
+# 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)., 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
+    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
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(country_code:, national_number:)
+      @country_code = country_code
+      @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.
+      country_code = hash.key?('country_code') ? hash['country_code'] : nil
+      national_number =
+        hash.key?('national_number') ? hash['national_number'] : nil
+
+      # Create object from extracted values.
+      PhoneNumberWithCountryCode.new(country_code: country_code,
+                                     national_number: national_number)
+    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_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

@@ -0,0 +1,48 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The phone type.
+  class PhoneType
+    PHONE_TYPE = [
+      # Fax number.
+      FAX = 'FAX'.freeze,
+
+      # Home phone number.
+      HOME = 'HOME'.freeze,
+
+      # Mobile phone number.
+      MOBILE = 'MOBILE'.freeze,
+
+      # Other phone number.
+      OTHER = 'OTHER'.freeze,
+
+      # Pager number.
+      PAGER = 'PAGER'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = FAX)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'fax' then FAX
+      when 'home' then HOME
+      when 'mobile' then MOBILE
+      when 'other' then OTHER
+      when 'pager' then PAGER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/phone_with_type.rb

@@ -0,0 +1,72 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The phone information.
+  class PhoneWithType < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The phone type.
+    # @return [PhoneType]
+    attr_accessor :phone_type
+
+    # The phone number in its canonical international [E.164 numbering plan
+    # format](https://www.itu.int/rec/T-REC-E.164/en).
+    # @return [PhoneNumber]
+    attr_accessor :phone_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['phone_type'] = 'phone_type'
+      @_hash['phone_number'] = 'phone_number'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        phone_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(phone_number:, phone_type: SKIP)
+      @phone_type = phone_type unless phone_type == SKIP
+      @phone_number = phone_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.
+      phone_number = PhoneNumber.from_hash(hash['phone_number']) if hash['phone_number']
+      phone_type = hash.key?('phone_type') ? hash['phone_type'] : SKIP
+
+      # Create object from extracted values.
+      PhoneWithType.new(phone_number: phone_number,
+                        phone_type: phone_type)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} phone_type: #{@phone_type}, phone_number: #{@phone_number}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} phone_type: #{@phone_type.inspect}, phone_number:"\
+      " #{@phone_number.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/plan.rb

@@ -0,0 +1,92 @@
+# paypal_server_sdk
+#
+# 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
+  # Agreement.
+  class Plan < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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[BillingCycle]]
+    attr_accessor :billing_cycles
+
+    # The one-time charge info at the time of checkout.
+    # @return [OneTimeCharge]
+    attr_accessor :one_time_charges
+
+    # Name of the recurring plan.
+    # @return [String]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['billing_cycles'] = 'billing_cycles'
+      @_hash['one_time_charges'] = 'one_time_charges'
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(billing_cycles:, one_time_charges:, name: SKIP)
+      @billing_cycles = billing_cycles
+      @one_time_charges = one_time_charges
+      @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.
+      # 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 << (BillingCycle.from_hash(structure) if structure)
+        end
+      end
+
+      billing_cycles = nil unless hash.key?('billing_cycles')
+      one_time_charges = OneTimeCharge.from_hash(hash['one_time_charges']) if
+        hash['one_time_charges']
+      name = hash.key?('name') ? hash['name'] : SKIP
+
+      # Create object from extracted values.
+      Plan.new(billing_cycles: billing_cycles,
+               one_time_charges: one_time_charges,
+               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}, 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}, 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