newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/request.rb

@@ -0,0 +1,116 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module NewStoreApi
+  # Request Model.
+  class Request < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :reason
+
+    # TODO: Write general description for this method
+    # @return [TrackingStatusEnum]
+    attr_accessor :status
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :tracking_code
+
+    # Set by carrier. It is the time at which the event has been
+    # recorded/generated by the carrier.
+    # @return [DateTime]
+    attr_accessor :updated_at
+
+    # Set by carrier. It is the time at which the event has been
+    # recorded/generated by the carrier.
+    # @return [String]
+    attr_accessor :easypost_marker
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['reason'] = 'reason'
+      @_hash['status'] = 'status'
+      @_hash['tracking_code'] = 'tracking_code'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash['easypost_marker'] = 'easypost_marker'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        reason
+        status
+        tracking_code
+        updated_at
+        easypost_marker
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        reason
+      ]
+    end
+
+    def initialize(reason = SKIP, status = SKIP, tracking_code = SKIP,
+                   updated_at = SKIP, easypost_marker = SKIP)
+      @reason = reason unless reason == SKIP
+      @status = status unless status == SKIP
+      @tracking_code = tracking_code unless tracking_code == SKIP
+      @updated_at = updated_at unless updated_at == SKIP
+      @easypost_marker = easypost_marker unless easypost_marker == 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.
+      reason = hash.key?('reason') ? hash['reason'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      tracking_code = hash.key?('tracking_code') ? hash['tracking_code'] : SKIP
+      updated_at = if hash.key?('updated_at')
+                     (DateTimeHelper.from_rfc3339(hash['updated_at']) if hash['updated_at'])
+                   else
+                     SKIP
+                   end
+      easypost_marker =
+        hash.key?('easypost_marker') ? hash['easypost_marker'] : SKIP
+
+      # Create object from extracted values.
+      Request.new(reason,
+                  status,
+                  tracking_code,
+                  updated_at,
+                  easypost_marker)
+    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} reason: #{@reason}, status: #{@status}, tracking_code: #{@tracking_code},"\
+      " updated_at: #{@updated_at}, easypost_marker: #{@easypost_marker}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} reason: #{@reason.inspect}, status: #{@status.inspect}, tracking_code:"\
+      " #{@tracking_code.inspect}, updated_at: #{@updated_at.inspect}, easypost_marker:"\
+      " #{@easypost_marker.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/request_context.rb

@@ -0,0 +1,111 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # The HTTP request that carried the audited change.
+  class RequestContext < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # HTTP method.
+    # @return [String]
+    attr_accessor :method
+
+    # HTTP URL path.
+    # @return [String]
+    attr_accessor :path
+
+    # X-Newstore-Request-Id header.
+    # @return [String]
+    attr_accessor :request_id
+
+    # Client IP (first X-Forwarded-For hop, else RemoteAddr).
+    # @return [String]
+    attr_accessor :source_ip
+
+    # W3C traceparent trace-id segment.
+    # @return [String]
+    attr_accessor :trace_id
+
+    # User-Agent header.
+    # @return [String]
+    attr_accessor :user_agent
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['method'] = 'method'
+      @_hash['path'] = 'path'
+      @_hash['request_id'] = 'request_id'
+      @_hash['source_ip'] = 'source_ip'
+      @_hash['trace_id'] = 'trace_id'
+      @_hash['user_agent'] = 'user_agent'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        method
+        path
+        request_id
+        source_ip
+        trace_id
+        user_agent
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(method = SKIP, path = SKIP, request_id = SKIP,
+                   source_ip = SKIP, trace_id = SKIP, user_agent = SKIP)
+      @method = method unless method == SKIP
+      @path = path unless path == SKIP
+      @request_id = request_id unless request_id == SKIP
+      @source_ip = source_ip unless source_ip == SKIP
+      @trace_id = trace_id unless trace_id == SKIP
+      @user_agent = user_agent unless user_agent == 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.
+      method = hash.key?('method') ? hash['method'] : SKIP
+      path = hash.key?('path') ? hash['path'] : SKIP
+      request_id = hash.key?('request_id') ? hash['request_id'] : SKIP
+      source_ip = hash.key?('source_ip') ? hash['source_ip'] : SKIP
+      trace_id = hash.key?('trace_id') ? hash['trace_id'] : SKIP
+      user_agent = hash.key?('user_agent') ? hash['user_agent'] : SKIP
+
+      # Create object from extracted values.
+      RequestContext.new(method,
+                         path,
+                         request_id,
+                         source_ip,
+                         trace_id,
+                         user_agent)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} method: #{@method}, path: #{@path}, request_id: #{@request_id}, source_ip:"\
+      " #{@source_ip}, trace_id: #{@trace_id}, user_agent: #{@user_agent}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} method: #{@method.inspect}, path: #{@path.inspect}, request_id:"\
+      " #{@request_id.inspect}, source_ip: #{@source_ip.inspect}, trace_id: #{@trace_id.inspect},"\
+      " user_agent: #{@user_agent.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/request_create_bookings.rb

@@ -0,0 +1,137 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # RequestCreateBookings Model.
+  class RequestCreateBookings < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # default true. book outbound shipment using location's sender address.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :book_outbound
+
+    # default false. if true, will use the recipient address as sender and the
+    # location's address as recipient.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :book_return
+
+    # default false. if true, will use the recipient address as sender and the
+    # location's address as recipient.
+    # @return [String]
+    attr_accessor :external_order_id
+
+    # the location sending the shipment, or receiving it from customer if
+    # booking a return.
+    # @return [String]
+    attr_accessor :location_id
+
+    # the location sending the shipment, or receiving it from customer if
+    # booking a return.
+    # @return [UUID | String]
+    attr_accessor :option_id
+
+    # the location sending the shipment, or receiving it from customer if
+    # booking a return.
+    # @return [Array[RequestPackage]]
+    attr_accessor :packages
+
+    # Address the shipment is sent to. In case of a return shipment, this
+    # address will be used as the sender even though it says recipient.
+    # Recipient is meant as the address used by the initial shipment that
+    # shipped goods initially.
+    # @return [RequestRecipientAddress]
+    attr_accessor :recipient_address
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['book_outbound'] = 'book_outbound'
+      @_hash['book_return'] = 'book_return'
+      @_hash['external_order_id'] = 'external_order_id'
+      @_hash['location_id'] = 'location_id'
+      @_hash['option_id'] = 'option_id'
+      @_hash['packages'] = 'packages'
+      @_hash['recipient_address'] = 'recipient_address'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        book_outbound
+        book_return
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(external_order_id = nil, location_id = nil, option_id = nil,
+                   packages = nil, recipient_address = nil,
+                   book_outbound = true, book_return = false)
+      @book_outbound = book_outbound unless book_outbound == SKIP
+      @book_return = book_return unless book_return == SKIP
+      @external_order_id = external_order_id
+      @location_id = location_id
+      @option_id = option_id
+      @packages = packages
+      @recipient_address = recipient_address
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      external_order_id =
+        hash.key?('external_order_id') ? hash['external_order_id'] : nil
+      location_id = hash.key?('location_id') ? hash['location_id'] : nil
+      option_id = hash.key?('option_id') ? hash['option_id'] : nil
+      # Parameter is an array, so we need to iterate through it
+      packages = nil
+      unless hash['packages'].nil?
+        packages = []
+        hash['packages'].each do |structure|
+          packages << (RequestPackage.from_hash(structure) if structure)
+        end
+      end
+
+      packages = nil unless hash.key?('packages')
+      recipient_address = RequestRecipientAddress.from_hash(hash['recipient_address']) if
+        hash['recipient_address']
+      book_outbound = hash['book_outbound'] ||= true
+      book_return = hash['book_return'] ||= false
+
+      # Create object from extracted values.
+      RequestCreateBookings.new(external_order_id,
+                                location_id,
+                                option_id,
+                                packages,
+                                recipient_address,
+                                book_outbound,
+                                book_return)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} book_outbound: #{@book_outbound}, book_return: #{@book_return},"\
+      " external_order_id: #{@external_order_id}, location_id: #{@location_id}, option_id:"\
+      " #{@option_id}, packages: #{@packages}, recipient_address: #{@recipient_address}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} book_outbound: #{@book_outbound.inspect}, book_return:"\
+      " #{@book_return.inspect}, external_order_id: #{@external_order_id.inspect}, location_id:"\
+      " #{@location_id.inspect}, option_id: #{@option_id.inspect}, packages: #{@packages.inspect},"\
+      " recipient_address: #{@recipient_address.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/request_create_manifest.rb

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

data/lib/new_store_api/models/request_package.rb

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

data/lib/new_store_api/models/request_package_customs.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
+  # RequestPackageCustoms Model.
+  class RequestPackageCustoms < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :customs_signer
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :itn
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['customs_signer'] = 'customs_signer'
+      @_hash['itn'] = 'itn'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        itn
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        itn
+      ]
+    end
+
+    def initialize(customs_signer = nil, itn = SKIP)
+      @customs_signer = customs_signer
+      @itn = itn unless itn == 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.
+      customs_signer =
+        hash.key?('customs_signer') ? hash['customs_signer'] : nil
+      itn = hash.key?('itn') ? hash['itn'] : SKIP
+
+      # Create object from extracted values.
+      RequestPackageCustoms.new(customs_signer,
+                                itn)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} customs_signer: #{@customs_signer}, itn: #{@itn}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} customs_signer: #{@customs_signer.inspect}, itn: #{@itn.inspect}>"
+    end
+  end
+end