newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/pagination_info.rb

@@ -0,0 +1,77 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Pagination info.
+  class PaginationInfo < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Amount of items in the current page.
+    # @return [Integer]
+    attr_accessor :count
+
+    # Offset of the current page.
+    # @return [Integer]
+    attr_accessor :offset
+
+    # Total amount of the items for given filters set.
+    # @return [Integer]
+    attr_accessor :total
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['count'] = 'count'
+      @_hash['offset'] = 'offset'
+      @_hash['total'] = 'total'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(count = nil, offset = nil, total = nil)
+      @count = count
+      @offset = offset
+      @total = total
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      count = hash.key?('count') ? hash['count'] : nil
+      offset = hash.key?('offset') ? hash['offset'] : nil
+      total = hash.key?('total') ? hash['total'] : nil
+
+      # Create object from extracted values.
+      PaginationInfo.new(count,
+                         offset,
+                         total)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} count: #{@count}, offset: #{@offset}, total: #{@total}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} count: #{@count.inspect}, offset: #{@offset.inspect}, total:"\
+      " #{@total.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/patch_import_request.rb

@@ -0,0 +1,63 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # PatchImportRequest Model.
+  class PatchImportRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Controls whether or not the segmentation import is visible in the
+    # Associate App as an outreach list.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_enabled
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['is_enabled'] = 'is_enabled'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        is_enabled
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(is_enabled = SKIP)
+      @is_enabled = is_enabled unless is_enabled == 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.
+      is_enabled = hash.key?('is_enabled') ? hash['is_enabled'] : SKIP
+
+      # Create object from extracted values.
+      PatchImportRequest.new(is_enabled)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} is_enabled: #{@is_enabled}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} is_enabled: #{@is_enabled.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/payment.rb

@@ -0,0 +1,77 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # The payments attached to an order.
+  class Payment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Already-authorized or already-captured payments to attach to the order.
+    # Must be empty for zero-value orders.
+    # @return [Array[Object]]
+    attr_accessor :instruments
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['instruments'] = 'instruments'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(instruments = nil)
+      @instruments = instruments
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      instruments = hash.key?('instruments') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:PaymentInstruments), hash['instruments']
+      ) : nil
+
+      # Create object from extracted values.
+      Payment.new(instruments)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Payment | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return UnionTypeLookUp.get(:PaymentInstruments)
+                              .validate(value.instruments)
+      end
+
+      return false unless value.instance_of? Hash
+
+      UnionTypeLookUp.get(:PaymentInstruments)
+                     .validate(value['instruments'])
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} instruments: #{@instruments}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} instruments: #{@instruments.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/payment1.rb

@@ -0,0 +1,87 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Payment1 Model.
+  class Payment1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :amount
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :currency
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :processor
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :psp_reference
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash['processor'] = 'processor'
+      @_hash['psp_reference'] = 'psp_reference'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount = nil, currency = nil, processor = nil,
+                   psp_reference = nil)
+      @amount = amount
+      @currency = currency
+      @processor = processor
+      @psp_reference = psp_reference
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      processor = hash.key?('processor') ? hash['processor'] : nil
+      psp_reference = hash.key?('psp_reference') ? hash['psp_reference'] : nil
+
+      # Create object from extracted values.
+      Payment1.new(amount,
+                   currency,
+                   processor,
+                   psp_reference)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount}, currency: #{@currency}, processor: #{@processor},"\
+      " psp_reference: #{@psp_reference}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount.inspect}, currency: #{@currency.inspect}, processor:"\
+      " #{@processor.inspect}, psp_reference: #{@psp_reference.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/payment_link_get_response.rb

@@ -0,0 +1,90 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # PaymentLinkGetResponse Model.
+  class PaymentLinkGetResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Payment1]
+    attr_accessor :payment
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :payment_link_url
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :payment_reference
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payment'] = 'payment'
+      @_hash['payment_link_url'] = 'payment_link_url'
+      @_hash['payment_reference'] = 'payment_reference'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payment = nil, payment_link_url = nil,
+                   payment_reference = nil, status = nil)
+      @payment = payment
+      @payment_link_url = payment_link_url
+      @payment_reference = payment_reference
+      @status = status
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      payment = Payment1.from_hash(hash['payment']) if hash['payment']
+      payment_link_url =
+        hash.key?('payment_link_url') ? hash['payment_link_url'] : nil
+      payment_reference =
+        hash.key?('payment_reference') ? hash['payment_reference'] : nil
+      status = hash.key?('status') ? hash['status'] : nil
+
+      # Create object from extracted values.
+      PaymentLinkGetResponse.new(payment,
+                                 payment_link_url,
+                                 payment_reference,
+                                 status)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} payment: #{@payment}, payment_link_url: #{@payment_link_url},"\
+      " payment_reference: #{@payment_reference}, status: #{@status}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} payment: #{@payment.inspect}, payment_link_url:"\
+      " #{@payment_link_url.inspect}, payment_reference: #{@payment_reference.inspect}, status:"\
+      " #{@status.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/payment_link_request.rb

@@ -0,0 +1,101 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Creates a payment link.
+  class PaymentLinkRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The amount of the payment in major units (e.g. 9.95 for $9.95). Decimal
+    # precision depends on the currency.
+    # @return [Float]
+    attr_accessor :amount
+
+    # Optional merchant endpoint called when this payment link succeeds via `PUT
+    # /payment-links/{payment_reference}/_success`.
+    # @return [String]
+    attr_accessor :callback_url
+
+    # The currency of the payment.
+    # @return [String]
+    attr_accessor :currency
+
+    # Customer object for optional risk assessment.
+    # @return [Customer1]
+    attr_accessor :customer
+
+    # The store identifier for the payment link.
+    # @return [String]
+    attr_accessor :store_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['callback_url'] = 'callback_url'
+      @_hash['currency'] = 'currency'
+      @_hash['customer'] = 'customer'
+      @_hash['store_id'] = 'store_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        callback_url
+        customer
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount = nil, currency = nil, store_id = nil,
+                   callback_url = SKIP, customer = SKIP)
+      @amount = amount
+      @callback_url = callback_url unless callback_url == SKIP
+      @currency = currency
+      @customer = customer unless customer == SKIP
+      @store_id = store_id
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      store_id = hash.key?('store_id') ? hash['store_id'] : nil
+      callback_url = hash.key?('callback_url') ? hash['callback_url'] : SKIP
+      customer = Customer1.from_hash(hash['customer']) if hash['customer']
+
+      # Create object from extracted values.
+      PaymentLinkRequest.new(amount,
+                             currency,
+                             store_id,
+                             callback_url,
+                             customer)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount}, callback_url: #{@callback_url}, currency: #{@currency},"\
+      " customer: #{@customer}, store_id: #{@store_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount.inspect}, callback_url: #{@callback_url.inspect},"\
+      " currency: #{@currency.inspect}, customer: #{@customer.inspect}, store_id:"\
+      " #{@store_id.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/payment_link_response.rb

@@ -0,0 +1,81 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # PaymentLinkResponse Model.
+  class PaymentLinkResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :payment_link_url
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :payment_reference
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payment_link_url'] = 'payment_link_url'
+      @_hash['payment_reference'] = 'payment_reference'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payment_link_url = nil, payment_reference = nil,
+                   status = nil)
+      @payment_link_url = payment_link_url
+      @payment_reference = payment_reference
+      @status = status
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      payment_link_url =
+        hash.key?('payment_link_url') ? hash['payment_link_url'] : nil
+      payment_reference =
+        hash.key?('payment_reference') ? hash['payment_reference'] : nil
+      status = hash.key?('status') ? hash['status'] : nil
+
+      # Create object from extracted values.
+      PaymentLinkResponse.new(payment_link_url,
+                              payment_reference,
+                              status)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} payment_link_url: #{@payment_link_url}, payment_reference:"\
+      " #{@payment_reference}, status: #{@status}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} payment_link_url: #{@payment_link_url.inspect}, payment_reference:"\
+      " #{@payment_reference.inspect}, status: #{@status.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/payment_status_enum.rb

@@ -0,0 +1,36 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Whether the supplied payment is already authorized or already captured.
+  class PaymentStatusEnum
+    PAYMENT_STATUS_ENUM = [
+      # TODO: Write general description for AUTHORIZED
+      AUTHORIZED = 'AUTHORIZED'.freeze,
+
+      # TODO: Write general description for CAPTURED
+      CAPTURED = 'CAPTURED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PAYMENT_STATUS_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = AUTHORIZED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'authorized' then AUTHORIZED
+      when 'captured' then CAPTURED
+      else
+        default_value
+      end
+    end
+  end
+end