newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/gift_wrapping1.rb

@@ -0,0 +1,116 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Indicates if gift wrapping option was selected for the order. Only
+  # information from the first item (message and price) will be taken into
+  # account.
+  class GiftWrapping1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Price of the item, including taxes or not, depending on the value of the
+    # `price_method` property.
+    # @return [Float]
+    attr_accessor :item_price
+
+    # Describes the taxes applied to the item.
+    # @return [Array[InjectedOrderItemTaxLine]]
+    attr_accessor :item_tax_lines
+
+    # Message to be attached to the gift-wrapped order. Its length is
+    # configurable per tenant.
+    # @return [String]
+    attr_accessor :message
+
+    # Tax classification identifier for the line item
+    # @return [String]
+    attr_accessor :tax_class
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['item_price'] = 'item_price'
+      @_hash['item_tax_lines'] = 'item_tax_lines'
+      @_hash['message'] = 'message'
+      @_hash['tax_class'] = 'tax_class'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        item_price
+        item_tax_lines
+        message
+        tax_class
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(item_price = SKIP, item_tax_lines = SKIP, message = SKIP,
+                   tax_class = SKIP)
+      @item_price = item_price unless item_price == SKIP
+      @item_tax_lines = item_tax_lines unless item_tax_lines == SKIP
+      @message = message unless message == SKIP
+      @tax_class = tax_class unless tax_class == 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.
+      item_price = hash.key?('item_price') ? hash['item_price'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      item_tax_lines = nil
+      unless hash['item_tax_lines'].nil?
+        item_tax_lines = []
+        hash['item_tax_lines'].each do |structure|
+          item_tax_lines << (InjectedOrderItemTaxLine.from_hash(structure) if structure)
+        end
+      end
+
+      item_tax_lines = SKIP unless hash.key?('item_tax_lines')
+      message = hash.key?('message') ? hash['message'] : SKIP
+      tax_class = hash.key?('tax_class') ? hash['tax_class'] : SKIP
+
+      # Create object from extracted values.
+      GiftWrapping1.new(item_price,
+                        item_tax_lines,
+                        message,
+                        tax_class)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [GiftWrapping1 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} item_price: #{@item_price}, item_tax_lines: #{@item_tax_lines}, message:"\
+      " #{@message}, tax_class: #{@tax_class}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} item_price: #{@item_price.inspect}, item_tax_lines:"\
+      " #{@item_tax_lines.inspect}, message: #{@message.inspect}, tax_class:"\
+      " #{@tax_class.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/historical_order_shipment.rb

@@ -0,0 +1,133 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module NewStoreApi
+  # Shipment of a historical order that has already been shipped from a
+  # fulfillment location. A historical order represents an already completed
+  # order that was imported from an external system, into NewStore.
+  class HistoricalOrderShipment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [HistoricalShippingOption]
+    attr_accessor :historical_shipping_option
+
+    # TODO: Write general description for this method
+    # @return [Array[InjectedOrderShipmentItem]]
+    attr_accessor :items
+
+    # Date representation of when the shipment was shipped, containing date,
+    # time and timezone as defined by https://tools.ietf.org/html/rfc3339 (ISO
+    # 8601). In case not provided, is set to placed_at.
+    # @return [DateTime]
+    attr_accessor :shipped_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['historical_shipping_option'] = 'historical_shipping_option'
+      @_hash['items'] = 'items'
+      @_hash['shipped_at'] = 'shipped_at'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        shipped_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(historical_shipping_option = nil, items = nil,
+                   shipped_at = SKIP)
+      @historical_shipping_option = historical_shipping_option
+      @items = items
+      @shipped_at = shipped_at unless shipped_at == 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.
+      if hash['historical_shipping_option']
+        historical_shipping_option = HistoricalShippingOption.from_hash(hash['historical_shipping_option'])
+      end
+      # Parameter is an array, so we need to iterate through it
+      items = nil
+      unless hash['items'].nil?
+        items = []
+        hash['items'].each do |structure|
+          items << (InjectedOrderShipmentItem.from_hash(structure) if structure)
+        end
+      end
+
+      items = nil unless hash.key?('items')
+      shipped_at = if hash.key?('shipped_at')
+                     (DateTimeHelper.from_rfc3339(hash['shipped_at']) if hash['shipped_at'])
+                   else
+                     SKIP
+                   end
+
+      # Create object from extracted values.
+      HistoricalOrderShipment.new(historical_shipping_option,
+                                  items,
+                                  shipped_at)
+    end
+
+    def to_custom_shipped_at
+      DateTimeHelper.to_rfc3339(shipped_at)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [HistoricalOrderShipment | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.historical_shipping_option,
+                                ->(val) { HistoricalShippingOption.validate(val) },
+                                is_model_hash: true) and
+            APIHelper.valid_type?(value.items,
+                                  ->(val) { InjectedOrderShipmentItem.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['historical_shipping_option'],
+                              ->(val) { HistoricalShippingOption.validate(val) },
+                              is_model_hash: true) and
+          APIHelper.valid_type?(value['items'],
+                                ->(val) { InjectedOrderShipmentItem.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true)
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} historical_shipping_option: #{@historical_shipping_option}, items:"\
+      " #{@items}, shipped_at: #{@shipped_at}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} historical_shipping_option: #{@historical_shipping_option.inspect}, items:"\
+      " #{@items.inspect}, shipped_at: #{@shipped_at.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/historical_shipping_option.rb

@@ -0,0 +1,226 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # HistoricalShippingOption Model.
+  class HistoricalShippingOption < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Country code in ISO 3166 ALPHA-2 format.
+    # @return [CountryCodeEnum]
+    attr_accessor :country_code
+
+    # Shipping option display details, in case of traditional carrier contains
+    # estimated delivery time.
+    # @return [String]
+    attr_accessor :delivery_details
+
+    # Information about shipping discounts applied to the shipment.
+    # @return [Array[Object]]
+    attr_accessor :discount_info
+
+    # Shipping option display name.
+    # @return [String]
+    attr_accessor :display_name
+
+    # Identifier of the fulfillment node preselected for that shipment.
+    # @return [String]
+    attr_accessor :fulfillment_node_id
+
+    # The price of the shipping option before discounts. It might include taxes
+    # depending on the tax method.
+    # @return [Float]
+    attr_accessor :price
+
+    # Service level identifier of the shipping option. Set it to
+    # IN_STORE_HANDOVER in case of injecting an in-store purchase order.
+    # @return [String]
+    attr_accessor :service_level_identifier
+
+    # Shipping carrier code, e.g. 'USPS' or 'Deliv'.
+    # @return [String]
+    attr_accessor :shipping_carrier
+
+    # Shipping type.
+    # @return [ShippingTypeEnum]
+    attr_accessor :shipping_type
+
+    # Identifier of the store preselected for that shipment. Required for
+    # in_store_pick_up and in_store_handover.
+    # @return [String]
+    attr_accessor :store_id
+
+    # The tax applied to the shipping option.
+    # @return [Float]
+    attr_accessor :tax
+
+    # Shipping origin zip code.
+    # @return [String]
+    attr_accessor :zip_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['country_code'] = 'country_code'
+      @_hash['delivery_details'] = 'delivery_details'
+      @_hash['discount_info'] = 'discount_info'
+      @_hash['display_name'] = 'display_name'
+      @_hash['fulfillment_node_id'] = 'fulfillment_node_id'
+      @_hash['price'] = 'price'
+      @_hash['service_level_identifier'] = 'service_level_identifier'
+      @_hash['shipping_carrier'] = 'shipping_carrier'
+      @_hash['shipping_type'] = 'shipping_type'
+      @_hash['store_id'] = 'store_id'
+      @_hash['tax'] = 'tax'
+      @_hash['zip_code'] = 'zip_code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        delivery_details
+        discount_info
+        store_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(country_code = nil, display_name = nil,
+                   fulfillment_node_id = nil, price = nil,
+                   service_level_identifier = nil, shipping_carrier = nil,
+                   shipping_type = nil, tax = nil, zip_code = nil,
+                   delivery_details = SKIP, discount_info = SKIP,
+                   store_id = SKIP)
+      @country_code = country_code
+      @delivery_details = delivery_details unless delivery_details == SKIP
+      @discount_info = discount_info unless discount_info == SKIP
+      @display_name = display_name
+      @fulfillment_node_id = fulfillment_node_id
+      @price = price
+      @service_level_identifier = service_level_identifier
+      @shipping_carrier = shipping_carrier
+      @shipping_type = shipping_type
+      @store_id = store_id unless store_id == SKIP
+      @tax = tax
+      @zip_code = zip_code
+    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
+      display_name = hash.key?('display_name') ? hash['display_name'] : nil
+      fulfillment_node_id =
+        hash.key?('fulfillment_node_id') ? hash['fulfillment_node_id'] : nil
+      price = hash.key?('price') ? hash['price'] : nil
+      service_level_identifier =
+        hash.key?('service_level_identifier') ? hash['service_level_identifier'] : nil
+      shipping_carrier =
+        hash.key?('shipping_carrier') ? hash['shipping_carrier'] : nil
+      shipping_type = hash.key?('shipping_type') ? hash['shipping_type'] : nil
+      tax = hash.key?('tax') ? hash['tax'] : nil
+      zip_code = hash.key?('zip_code') ? hash['zip_code'] : nil
+      delivery_details =
+        hash.key?('delivery_details') ? hash['delivery_details'] : SKIP
+      discount_info = hash.key?('discount_info') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:InjectedOrderDiscountInfo2), hash['discount_info']
+      ) : SKIP
+      store_id = hash.key?('store_id') ? hash['store_id'] : SKIP
+
+      # Create object from extracted values.
+      HistoricalShippingOption.new(country_code,
+                                   display_name,
+                                   fulfillment_node_id,
+                                   price,
+                                   service_level_identifier,
+                                   shipping_carrier,
+                                   shipping_type,
+                                   tax,
+                                   zip_code,
+                                   delivery_details,
+                                   discount_info,
+                                   store_id)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [HistoricalShippingOption | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.country_code,
+                                ->(val) { CountryCodeEnum.validate(val) }) and
+            APIHelper.valid_type?(value.display_name,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.fulfillment_node_id,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.price,
+                                  ->(val) { val.instance_of? Float }) and
+            APIHelper.valid_type?(value.service_level_identifier,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.shipping_carrier,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.shipping_type,
+                                  ->(val) { ShippingTypeEnum.validate(val) }) and
+            APIHelper.valid_type?(value.tax,
+                                  ->(val) { val.instance_of? Float }) and
+            APIHelper.valid_type?(value.zip_code,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['country_code'],
+                              ->(val) { CountryCodeEnum.validate(val) }) and
+          APIHelper.valid_type?(value['display_name'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['fulfillment_node_id'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['price'],
+                                ->(val) { val.instance_of? Float }) and
+          APIHelper.valid_type?(value['service_level_identifier'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['shipping_carrier'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['shipping_type'],
+                                ->(val) { ShippingTypeEnum.validate(val) }) and
+          APIHelper.valid_type?(value['tax'],
+                                ->(val) { val.instance_of? Float }) and
+          APIHelper.valid_type?(value['zip_code'],
+                                ->(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} country_code: #{@country_code}, delivery_details: #{@delivery_details},"\
+      " discount_info: #{@discount_info}, display_name: #{@display_name}, fulfillment_node_id:"\
+      " #{@fulfillment_node_id}, price: #{@price}, service_level_identifier:"\
+      " #{@service_level_identifier}, shipping_carrier: #{@shipping_carrier}, shipping_type:"\
+      " #{@shipping_type}, store_id: #{@store_id}, tax: #{@tax}, zip_code: #{@zip_code}>"
+    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}, delivery_details:"\
+      " #{@delivery_details.inspect}, discount_info: #{@discount_info.inspect}, display_name:"\
+      " #{@display_name.inspect}, fulfillment_node_id: #{@fulfillment_node_id.inspect}, price:"\
+      " #{@price.inspect}, service_level_identifier: #{@service_level_identifier.inspect},"\
+      " shipping_carrier: #{@shipping_carrier.inspect}, shipping_type: #{@shipping_type.inspect},"\
+      " store_id: #{@store_id.inspect}, tax: #{@tax.inspect}, zip_code: #{@zip_code.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/http_response_body.rb

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

data/lib/new_store_api/models/identity_provider_config.rb

@@ -0,0 +1,102 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Identity Provider configuration
+  class IdentityProviderConfig < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :client_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :directory_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :entity_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :logout_uri
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :redirect_uri
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['client_id'] = 'client_id'
+      @_hash['directory_id'] = 'directory_id'
+      @_hash['entity_id'] = 'entity_id'
+      @_hash['logout_uri'] = 'logout_uri'
+      @_hash['redirect_uri'] = 'redirect_uri'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_id
+        directory_id
+        entity_id
+        logout_uri
+        redirect_uri
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(client_id = SKIP, directory_id = SKIP, entity_id = SKIP,
+                   logout_uri = SKIP, redirect_uri = SKIP)
+      @client_id = client_id unless client_id == SKIP
+      @directory_id = directory_id unless directory_id == SKIP
+      @entity_id = entity_id unless entity_id == SKIP
+      @logout_uri = logout_uri unless logout_uri == SKIP
+      @redirect_uri = redirect_uri unless redirect_uri == 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.
+      client_id = hash.key?('client_id') ? hash['client_id'] : SKIP
+      directory_id = hash.key?('directory_id') ? hash['directory_id'] : SKIP
+      entity_id = hash.key?('entity_id') ? hash['entity_id'] : SKIP
+      logout_uri = hash.key?('logout_uri') ? hash['logout_uri'] : SKIP
+      redirect_uri = hash.key?('redirect_uri') ? hash['redirect_uri'] : SKIP
+
+      # Create object from extracted values.
+      IdentityProviderConfig.new(client_id,
+                                 directory_id,
+                                 entity_id,
+                                 logout_uri,
+                                 redirect_uri)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} client_id: #{@client_id}, directory_id: #{@directory_id}, entity_id:"\
+      " #{@entity_id}, logout_uri: #{@logout_uri}, redirect_uri: #{@redirect_uri}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} client_id: #{@client_id.inspect}, directory_id: #{@directory_id.inspect},"\
+      " entity_id: #{@entity_id.inspect}, logout_uri: #{@logout_uri.inspect}, redirect_uri:"\
+      " #{@redirect_uri.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/identity_provider_protocol_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
+  # Supported Protocols for Identity Providers
+  class IdentityProviderProtocolEnum
+    IDENTITY_PROVIDER_PROTOCOL_ENUM = [
+      # TODO: Write general description for OIDC
+      OIDC = 'OIDC'.freeze,
+
+      # TODO: Write general description for SAML
+      SAML = 'SAML'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      IDENTITY_PROVIDER_PROTOCOL_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = OIDC)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'oidc' then OIDC
+      when 'saml' then SAML
+      else
+        default_value
+      end
+    end
+  end
+end