newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/canceled.rb

@@ -0,0 +1,91 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Canceled Model.
+  class Canceled < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :items
+
+    # The UUID of the new logistic order that has the cancelled items.
+    # @return [String]
+    attr_accessor :logistic_order_uuid
+
+    # The identifier of the logistic order that previously contained the
+    # rerouted items. This is the logistic order uuid that was specified in the
+    # request.
+    # @return [String]
+    attr_accessor :parent_logistic_order_uuid
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['items'] = 'items'
+      @_hash['logistic_order_uuid'] = 'logistic_order_uuid'
+      @_hash['parent_logistic_order_uuid'] = 'parent_logistic_order_uuid'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        items
+        logistic_order_uuid
+        parent_logistic_order_uuid
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(items = SKIP, logistic_order_uuid = SKIP,
+                   parent_logistic_order_uuid = SKIP)
+      @items = items unless items == SKIP
+      @logistic_order_uuid = logistic_order_uuid unless logistic_order_uuid == SKIP
+      unless parent_logistic_order_uuid == SKIP
+        @parent_logistic_order_uuid =
+          parent_logistic_order_uuid
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      items = hash.key?('items') ? hash['items'] : SKIP
+      logistic_order_uuid =
+        hash.key?('logistic_order_uuid') ? hash['logistic_order_uuid'] : SKIP
+      parent_logistic_order_uuid =
+        hash.key?('parent_logistic_order_uuid') ? hash['parent_logistic_order_uuid'] : SKIP
+
+      # Create object from extracted values.
+      Canceled.new(items,
+                   logistic_order_uuid,
+                   parent_logistic_order_uuid)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} items: #{@items}, logistic_order_uuid: #{@logistic_order_uuid},"\
+      " parent_logistic_order_uuid: #{@parent_logistic_order_uuid}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} items: #{@items.inspect}, logistic_order_uuid:"\
+      " #{@logistic_order_uuid.inspect}, parent_logistic_order_uuid:"\
+      " #{@parent_logistic_order_uuid.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/cancellation_policy_settings.rb

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

data/lib/new_store_api/models/cancellation_policy_settings_reasons_enum.rb

@@ -0,0 +1,53 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # CancellationPolicySettingsReasons.
+  class CancellationPolicySettingsReasonsEnum
+    CANCELLATION_POLICY_SETTINGS_REASONS_ENUM = [
+      # TODO: Write general description for INSUFFICIENT_STOCK
+      INSUFFICIENT_STOCK = 'insufficient_stock'.freeze,
+
+      # TODO: Write general description for FAILED_FULFILLMENT_NODE_MAPPING
+      FAILED_FULFILLMENT_NODE_MAPPING = 'failed_fulfillment_node_mapping'.freeze,
+
+      # TODO: Write general description for SHIPPING_OFFER_UPDATE_ERROR
+      SHIPPING_OFFER_UPDATE_ERROR = 'shipping_offer_update_error'.freeze,
+
+      # TODO: Write general description for ERROR
+      ERROR = 'error'.freeze,
+
+      # TODO: Write general description for
+      # NOT_ENOUGH_STOCK_TO_CREATE_ALLOCATION
+      NOT_ENOUGH_STOCK_TO_CREATE_ALLOCATION = 'not_enough_stock_to_create_allocation'.freeze,
+
+      # TODO: Write general description for LIMIT_OF_SHIPMENTS_EXCEEDED
+      LIMIT_OF_SHIPMENTS_EXCEEDED = 'limit_of_shipments_exceeded'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CANCELLATION_POLICY_SETTINGS_REASONS_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = INSUFFICIENT_STOCK)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'insufficient_stock' then INSUFFICIENT_STOCK
+      when 'failed_fulfillment_node_mapping' then FAILED_FULFILLMENT_NODE_MAPPING
+      when 'shipping_offer_update_error' then SHIPPING_OFFER_UPDATE_ERROR
+      when 'error' then ERROR
+      when 'not_enough_stock_to_create_allocation' then NOT_ENOUGH_STOCK_TO_CREATE_ALLOCATION
+      when 'limit_of_shipments_exceeded' then LIMIT_OF_SHIPMENTS_EXCEEDED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/cancellation_policy_settings_value.rb

@@ -0,0 +1,79 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Order cancellation policies.
+  class CancellationPolicySettingsValue < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Determines whether orders are canceled automatically in case of a
+    # conflict.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :default
+
+    # A list of reasons to prevent an automatic cancelation of an order (in case
+    # default is 'true') or to prevent an order being in the conflict state.
+    # @return [Array[CancellationPolicySettingsReasonsEnum]]
+    attr_accessor :reasons_to_overwrite_default
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['default'] = 'default'
+      @_hash['reasons_to_overwrite_default'] = 'reasons_to_overwrite_default'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        default
+        reasons_to_overwrite_default
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(default = true, reasons_to_overwrite_default = SKIP)
+      @default = default unless default == SKIP
+      unless reasons_to_overwrite_default == SKIP
+        @reasons_to_overwrite_default =
+          reasons_to_overwrite_default
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      default = hash['default'] ||= true
+      reasons_to_overwrite_default =
+        hash.key?('reasons_to_overwrite_default') ? hash['reasons_to_overwrite_default'] : SKIP
+
+      # Create object from extracted values.
+      CancellationPolicySettingsValue.new(default,
+                                          reasons_to_overwrite_default)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} default: #{@default}, reasons_to_overwrite_default:"\
+      " #{@reasons_to_overwrite_default}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} default: #{@default.inspect}, reasons_to_overwrite_default:"\
+      " #{@reasons_to_overwrite_default.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/capacity_based_routing_settings.rb

@@ -0,0 +1,82 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module NewStoreApi
+  # CapacityBasedRoutingSettings Model.
+  class CapacityBasedRoutingSettings < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :updated_at
+
+    # Tenant-based release toggle for the feature of capacity-based routing.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['updated_at'] = 'updated_at'
+      @_hash['value'] = 'value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        updated_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        updated_at
+        value
+      ]
+    end
+
+    def initialize(value = nil, updated_at = SKIP)
+      @updated_at = updated_at unless updated_at == SKIP
+      @value = value
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      value = hash.key?('value') ? hash['value'] : nil
+      updated_at = if hash.key?('updated_at')
+                     (DateTimeHelper.from_rfc3339(hash['updated_at']) if hash['updated_at'])
+                   else
+                     SKIP
+                   end
+
+      # Create object from extracted values.
+      CapacityBasedRoutingSettings.new(value,
+                                       updated_at)
+    end
+
+    def to_custom_updated_at
+      DateTimeHelper.to_rfc3339(updated_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} updated_at: #{@updated_at}, value: #{@value}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} updated_at: #{@updated_at.inspect}, value: #{@value.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/card_details.rb

@@ -0,0 +1,150 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Card-specific payment details.
+  class CardDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The card brand, for example `Visa` or `Mastercard`.
+    # @return [String]
+    attr_accessor :card_brand
+
+    # The last four digits of the card number.
+    # @return [String]
+    attr_accessor :card_last4
+
+    # The merchant account at the payment provider that settled this payment.
+    # Applies to Adyen only.
+    # @return [String]
+    attr_accessor :merchant_account
+
+    # How the card payment was taken, for example `terminal` or
+    # `apple_tap_to_pay`.
+    # @return [String]
+    attr_accessor :origin
+
+    # The payment provider's reference for this payment, for example the PSP
+    # reference.
+    # @return [String]
+    attr_accessor :reference
+
+    # Raw terminal receipt data captured at the point of sale, when available.
+    # Applies to Adyen only.
+    # @return [Object]
+    attr_accessor :terminal_receipt
+
+    # The wallet used to present the card, for example `apple_pay` or
+    # `google_pay`.
+    # @return [String]
+    attr_accessor :wallet
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['card_brand'] = 'card_brand'
+      @_hash['card_last4'] = 'card_last4'
+      @_hash['merchant_account'] = 'merchant_account'
+      @_hash['origin'] = 'origin'
+      @_hash['reference'] = 'reference'
+      @_hash['terminal_receipt'] = 'terminal_receipt'
+      @_hash['wallet'] = 'wallet'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        card_brand
+        card_last4
+        merchant_account
+        origin
+        terminal_receipt
+        wallet
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        card_brand
+        card_last4
+        merchant_account
+        origin
+        terminal_receipt
+        wallet
+      ]
+    end
+
+    def initialize(reference = nil, card_brand = SKIP, card_last4 = SKIP,
+                   merchant_account = SKIP, origin = SKIP,
+                   terminal_receipt = SKIP, wallet = SKIP)
+      @card_brand = card_brand unless card_brand == SKIP
+      @card_last4 = card_last4 unless card_last4 == SKIP
+      @merchant_account = merchant_account unless merchant_account == SKIP
+      @origin = origin unless origin == SKIP
+      @reference = reference
+      @terminal_receipt = terminal_receipt unless terminal_receipt == SKIP
+      @wallet = wallet unless wallet == 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.
+      reference = hash.key?('reference') ? hash['reference'] : nil
+      card_brand = hash.key?('card_brand') ? hash['card_brand'] : SKIP
+      card_last4 = hash.key?('card_last4') ? hash['card_last4'] : SKIP
+      merchant_account =
+        hash.key?('merchant_account') ? hash['merchant_account'] : SKIP
+      origin = hash.key?('origin') ? hash['origin'] : SKIP
+      terminal_receipt =
+        hash.key?('terminal_receipt') ? hash['terminal_receipt'] : SKIP
+      wallet = hash.key?('wallet') ? hash['wallet'] : SKIP
+
+      # Create object from extracted values.
+      CardDetails.new(reference,
+                      card_brand,
+                      card_last4,
+                      merchant_account,
+                      origin,
+                      terminal_receipt,
+                      wallet)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CardDetails | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.reference,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['reference'],
+                            ->(val) { val.instance_of? String })
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} card_brand: #{@card_brand}, card_last4: #{@card_last4}, merchant_account:"\
+      " #{@merchant_account}, origin: #{@origin}, reference: #{@reference}, terminal_receipt:"\
+      " #{@terminal_receipt}, wallet: #{@wallet}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} card_brand: #{@card_brand.inspect}, card_last4: #{@card_last4.inspect},"\
+      " merchant_account: #{@merchant_account.inspect}, origin: #{@origin.inspect}, reference:"\
+      " #{@reference.inspect}, terminal_receipt: #{@terminal_receipt.inspect}, wallet:"\
+      " #{@wallet.inspect}>"
+    end
+  end
+end