newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/schema_for_bulk_cancel_orders_response.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
+  # SchemaForBulkCancelOrdersResponse Model.
+  class SchemaForBulkCancelOrdersResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # List of failed cancellations with error details
+    # @return [Array[Failed]]
+    attr_accessor :failed
+
+    # List of successfully cancelled order IDs
+    # @return [Array[String]]
+    attr_accessor :succeeded
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['failed'] = 'failed'
+      @_hash['succeeded'] = 'succeeded'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(failed = nil, succeeded = nil)
+      @failed = failed
+      @succeeded = succeeded
+    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
+      failed = nil
+      unless hash['failed'].nil?
+        failed = []
+        hash['failed'].each do |structure|
+          failed << (Failed.from_hash(structure) if structure)
+        end
+      end
+
+      failed = nil unless hash.key?('failed')
+      succeeded = hash.key?('succeeded') ? hash['succeeded'] : nil
+
+      # Create object from extracted values.
+      SchemaForBulkCancelOrdersResponse.new(failed,
+                                            succeeded)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} failed: #{@failed}, succeeded: #{@succeeded}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} failed: #{@failed.inspect}, succeeded: #{@succeeded.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/section_enum.rb

@@ -0,0 +1,44 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # section.
+  class SectionEnum
+    SECTION_ENUM = [
+      # TODO: Write general description for ROUTES
+      ROUTES = 'routes'.freeze,
+
+      # TODO: Write general description for SL_LEVELS_PRIORITY
+      SL_LEVELS_PRIORITY = 'sl_levels_priority'.freeze,
+
+      # TODO: Write general description for LOCATION_GROUPS
+      LOCATION_GROUPS = 'location_groups'.freeze,
+
+      # TODO: Write general description for ZIP_CODE_REGIONS
+      ZIP_CODE_REGIONS = 'zip_code_regions'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SECTION_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ROUTES)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'routes' then ROUTES
+      when 'sl_levels_priority' then SL_LEVELS_PRIORITY
+      when 'location_groups' then LOCATION_GROUPS
+      when 'zip_code_regions' then ZIP_CODE_REGIONS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/service_level_rate.rb

@@ -0,0 +1,131 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # ServiceLevelRate Model.
+  class ServiceLevelRate < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An estimation of the time it will take to deliver the goods
+    # @return [String]
+    attr_accessor :delivery_time
+
+    # A human readable name of the service level
+    # @return [String]
+    attr_accessor :display_name
+
+    # Describes which goods can be fulfilled to which location, for the service
+    # level and given stocks at different locations as well as tenant's
+    # configuration
+    # @return [Array[FulfillmentAssignment]]
+    attr_accessor :fulfillment_assignments
+
+    # The service level id that correspond to a choice the user/customer can
+    # make, to then generate a real option.
+    # @return [String]
+    attr_accessor :service_level_id
+
+    # The total estimated shipping cost. This can be different than the addition
+    # of all assignments prices as it is driven by configuration. Do not use if
+    # either total_price or total_currency field is null.
+    # @return [String]
+    attr_accessor :total_price
+
+    # The total estimated shipping cost currency. Do not use if either
+    # total_price or total_currency field is null.
+    # @return [TotalPriceCurrencyEnum]
+    attr_accessor :total_price_currency
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['delivery_time'] = 'delivery_time'
+      @_hash['display_name'] = 'display_name'
+      @_hash['fulfillment_assignments'] = 'fulfillment_assignments'
+      @_hash['service_level_id'] = 'service_level_id'
+      @_hash['total_price'] = 'total_price'
+      @_hash['total_price_currency'] = 'total_price_currency'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        total_price
+        total_price_currency
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        total_price
+        total_price_currency
+      ]
+    end
+
+    def initialize(delivery_time = nil, display_name = nil,
+                   fulfillment_assignments = nil, service_level_id = nil,
+                   total_price = SKIP, total_price_currency = SKIP)
+      @delivery_time = delivery_time
+      @display_name = display_name
+      @fulfillment_assignments = fulfillment_assignments
+      @service_level_id = service_level_id
+      @total_price = total_price unless total_price == SKIP
+      @total_price_currency = total_price_currency unless total_price_currency == 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.
+      delivery_time = hash.key?('delivery_time') ? hash['delivery_time'] : nil
+      display_name = hash.key?('display_name') ? hash['display_name'] : nil
+      # Parameter is an array, so we need to iterate through it
+      fulfillment_assignments = nil
+      unless hash['fulfillment_assignments'].nil?
+        fulfillment_assignments = []
+        hash['fulfillment_assignments'].each do |structure|
+          fulfillment_assignments << (FulfillmentAssignment.from_hash(structure) if structure)
+        end
+      end
+
+      fulfillment_assignments = nil unless hash.key?('fulfillment_assignments')
+      service_level_id =
+        hash.key?('service_level_id') ? hash['service_level_id'] : nil
+      total_price = hash.key?('total_price') ? hash['total_price'] : SKIP
+      total_price_currency =
+        hash.key?('total_price_currency') ? hash['total_price_currency'] : SKIP
+
+      # Create object from extracted values.
+      ServiceLevelRate.new(delivery_time,
+                           display_name,
+                           fulfillment_assignments,
+                           service_level_id,
+                           total_price,
+                           total_price_currency)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} delivery_time: #{@delivery_time}, display_name: #{@display_name},"\
+      " fulfillment_assignments: #{@fulfillment_assignments}, service_level_id:"\
+      " #{@service_level_id}, total_price: #{@total_price}, total_price_currency:"\
+      " #{@total_price_currency}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} delivery_time: #{@delivery_time.inspect}, display_name:"\
+      " #{@display_name.inspect}, fulfillment_assignments: #{@fulfillment_assignments.inspect},"\
+      " service_level_id: #{@service_level_id.inspect}, total_price: #{@total_price.inspect},"\
+      " total_price_currency: #{@total_price_currency.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/service_levels.rb

@@ -0,0 +1,73 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # ServiceLevels Model.
+  class ServiceLevels < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Service level with which the order was fulfilled
+    # @return [String]
+    attr_accessor :current
+
+    # Service level with which the order was created
+    # @return [String]
+    attr_accessor :original
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['current'] = 'current'
+      @_hash['original'] = 'original'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        current
+        original
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        current
+      ]
+    end
+
+    def initialize(current = SKIP, original = SKIP)
+      @current = current unless current == SKIP
+      @original = original unless original == 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.
+      current = hash.key?('current') ? hash['current'] : SKIP
+      original = hash.key?('original') ? hash['original'] : SKIP
+
+      # Create object from extracted values.
+      ServiceLevels.new(current,
+                        original)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} current: #{@current}, original: #{@original}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} current: #{@current.inspect}, original: #{@original.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/session_token_response.rb

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

data/lib/new_store_api/models/set_fix_service_level_shipping_price.rb

@@ -0,0 +1,74 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # SetFixServiceLevelShippingPrice Model.
+  class SetFixServiceLevelShippingPrice < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['value'] = 'value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(value = nil)
+      @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
+
+      # Create object from extracted values.
+      SetFixServiceLevelShippingPrice.new(value)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SetFixServiceLevelShippingPrice | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.value,
+                                     ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['value'],
+                            ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass })
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} value: #{@value}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} value: #{@value.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/settings_response.rb

@@ -0,0 +1,69 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Versioned settings payload returned by read operations.
+  class SettingsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Settings keyed by declaration key (e.g. "associate-app", "payments"). The
+    # shape of each key's value is defined by the declaration's JSON Schema.
+    # @return [Object]
+    attr_accessor :data
+
+    # The current settings version label (e.g. "v42").
+    # @return [String]
+    attr_accessor :version
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['data'] = 'data'
+      @_hash['version'] = 'version'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data = nil, version = nil)
+      @data = data
+      @version = version
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      data = hash.key?('data') ? hash['data'] : nil
+      version = hash.key?('version') ? hash['version'] : nil
+
+      # Create object from extracted values.
+      SettingsResponse.new(data,
+                           version)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} data: #{@data}, version: #{@version}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} data: #{@data.inspect}, version: #{@version.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/shipment_limits_request.rb

@@ -0,0 +1,88 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Limit shipment rules for given currency x service level
+  class ShipmentLimitsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Currency alpha code in ISO 4217 format. Per example USD, EUR or JPY
+    # @return [String]
+    attr_accessor :currency
+
+    # Currency alpha code in ISO 4217 format. Per example USD, EUR or JPY
+    # @return [Array[LimitExceededWhen]]
+    attr_accessor :limit_exceeded_when
+
+    # Shipping service level
+    # @return [String]
+    attr_accessor :service_level
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['currency'] = 'currency'
+      @_hash['limit_exceeded_when'] = 'limit_exceeded_when'
+      @_hash['service_level'] = 'service_level'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(currency = nil, limit_exceeded_when = nil,
+                   service_level = nil)
+      @currency = currency
+      @limit_exceeded_when = limit_exceeded_when
+      @service_level = service_level
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      # Parameter is an array, so we need to iterate through it
+      limit_exceeded_when = nil
+      unless hash['limit_exceeded_when'].nil?
+        limit_exceeded_when = []
+        hash['limit_exceeded_when'].each do |structure|
+          limit_exceeded_when << (LimitExceededWhen.from_hash(structure) if structure)
+        end
+      end
+
+      limit_exceeded_when = nil unless hash.key?('limit_exceeded_when')
+      service_level = hash.key?('service_level') ? hash['service_level'] : nil
+
+      # Create object from extracted values.
+      ShipmentLimitsRequest.new(currency,
+                                limit_exceeded_when,
+                                service_level)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} currency: #{@currency}, limit_exceeded_when: #{@limit_exceeded_when},"\
+      " service_level: #{@service_level}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} currency: #{@currency.inspect}, limit_exceeded_when:"\
+      " #{@limit_exceeded_when.inspect}, service_level: #{@service_level.inspect}>"
+    end
+  end
+end