newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/response_booked_package.rb

@@ -0,0 +1,194 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # ResponseBookedPackage Model.
+  class ResponseBookedPackage < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :canceled_at
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :carrier_code
+
+    # commercial invoice URL after re-upload by newstore. this is the URL we
+    # want to expose to customers.
+    # @return [String]
+    attr_accessor :commercial_invoice_url
+
+    # commercial invoice URL after re-upload by newstore. this is the URL we
+    # want to expose to customers.
+    # @return [BookingResponseCost]
+    attr_accessor :cost
+
+    # label URL after re-upload by newstore. this is the URL we want to expose
+    # to customers.
+    # @return [String]
+    attr_accessor :label_url
+
+    # label URL after re-upload by newstore. this is the URL we want to expose
+    # to customers.
+    # @return [String]
+    attr_accessor :offer
+
+    # commercial invoice URL as returned from carrier/adapter.
+    # @return [String]
+    attr_accessor :original_commercial_invoice_url
+
+    # label URL as returned from carrier/adapter. this should stay internal: can
+    # be used for background re-upload for example.
+    # @return [String]
+    attr_accessor :original_label_url
+
+    # label URL as returned from carrier/adapter. this should stay internal: can
+    # be used for background re-upload for example.
+    # @return [Array[PackageTracking]]
+    attr_accessor :tracking
+
+    # label URL as returned from carrier/adapter. this should stay internal: can
+    # be used for background re-upload for example.
+    # @return [String]
+    attr_accessor :tracking_code
+
+    # label URL as returned from carrier/adapter. this should stay internal: can
+    # be used for background re-upload for example.
+    # @return [String]
+    attr_accessor :tracking_url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['canceled_at'] = 'canceled_at'
+      @_hash['carrier_code'] = 'carrier_code'
+      @_hash['commercial_invoice_url'] = 'commercial_invoice_url'
+      @_hash['cost'] = 'cost'
+      @_hash['label_url'] = 'label_url'
+      @_hash['offer'] = 'offer'
+      @_hash['original_commercial_invoice_url'] =
+        'original_commercial_invoice_url'
+      @_hash['original_label_url'] = 'original_label_url'
+      @_hash['tracking'] = 'tracking'
+      @_hash['tracking_code'] = 'tracking_code'
+      @_hash['tracking_url'] = 'tracking_url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        canceled_at
+        commercial_invoice_url
+        cost
+        label_url
+        offer
+        original_commercial_invoice_url
+        tracking
+        tracking_url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        canceled_at
+        commercial_invoice_url
+        cost
+        label_url
+        offer
+        original_commercial_invoice_url
+        tracking_url
+      ]
+    end
+
+    def initialize(carrier_code = nil, original_label_url = nil,
+                   tracking_code = nil, canceled_at = SKIP,
+                   commercial_invoice_url = SKIP, cost = SKIP, label_url = SKIP,
+                   offer = SKIP, original_commercial_invoice_url = SKIP,
+                   tracking = SKIP, tracking_url = SKIP)
+      @canceled_at = canceled_at unless canceled_at == SKIP
+      @carrier_code = carrier_code
+      @commercial_invoice_url = commercial_invoice_url unless commercial_invoice_url == SKIP
+      @cost = cost unless cost == SKIP
+      @label_url = label_url unless label_url == SKIP
+      @offer = offer unless offer == SKIP
+      unless original_commercial_invoice_url == SKIP
+        @original_commercial_invoice_url =
+          original_commercial_invoice_url
+      end
+      @original_label_url = original_label_url
+      @tracking = tracking unless tracking == SKIP
+      @tracking_code = tracking_code
+      @tracking_url = tracking_url unless tracking_url == 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.
+      carrier_code = hash.key?('carrier_code') ? hash['carrier_code'] : nil
+      original_label_url =
+        hash.key?('original_label_url') ? hash['original_label_url'] : nil
+      tracking_code = hash.key?('tracking_code') ? hash['tracking_code'] : nil
+      canceled_at = hash.key?('canceled_at') ? hash['canceled_at'] : SKIP
+      commercial_invoice_url =
+        hash.key?('commercial_invoice_url') ? hash['commercial_invoice_url'] : SKIP
+      cost = BookingResponseCost.from_hash(hash['cost']) if hash['cost']
+      label_url = hash.key?('label_url') ? hash['label_url'] : SKIP
+      offer = hash.key?('offer') ? hash['offer'] : SKIP
+      original_commercial_invoice_url =
+        hash.key?('original_commercial_invoice_url') ? hash['original_commercial_invoice_url'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      tracking = nil
+      unless hash['tracking'].nil?
+        tracking = []
+        hash['tracking'].each do |structure|
+          tracking << (PackageTracking.from_hash(structure) if structure)
+        end
+      end
+
+      tracking = SKIP unless hash.key?('tracking')
+      tracking_url = hash.key?('tracking_url') ? hash['tracking_url'] : SKIP
+
+      # Create object from extracted values.
+      ResponseBookedPackage.new(carrier_code,
+                                original_label_url,
+                                tracking_code,
+                                canceled_at,
+                                commercial_invoice_url,
+                                cost,
+                                label_url,
+                                offer,
+                                original_commercial_invoice_url,
+                                tracking,
+                                tracking_url)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} canceled_at: #{@canceled_at}, carrier_code: #{@carrier_code},"\
+      " commercial_invoice_url: #{@commercial_invoice_url}, cost: #{@cost}, label_url:"\
+      " #{@label_url}, offer: #{@offer}, original_commercial_invoice_url:"\
+      " #{@original_commercial_invoice_url}, original_label_url: #{@original_label_url}, tracking:"\
+      " #{@tracking}, tracking_code: #{@tracking_code}, tracking_url: #{@tracking_url}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} canceled_at: #{@canceled_at.inspect}, carrier_code:"\
+      " #{@carrier_code.inspect}, commercial_invoice_url: #{@commercial_invoice_url.inspect},"\
+      " cost: #{@cost.inspect}, label_url: #{@label_url.inspect}, offer: #{@offer.inspect},"\
+      " original_commercial_invoice_url: #{@original_commercial_invoice_url.inspect},"\
+      " original_label_url: #{@original_label_url.inspect}, tracking: #{@tracking.inspect},"\
+      " tracking_code: #{@tracking_code.inspect}, tracking_url: #{@tracking_url.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/response_booked_package_transaction.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
+  # A Transaction here means that you will ship a single package, with using one
+  # of the following combination: outbound/outbound+return/return You can see
+  # the "booked package" as a shipment. Then there can be an outbound shipment,
+  # and a return shipment.
+  class ResponseBookedPackageTransaction < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [ResponseBookedPackage]
+    attr_accessor :outbound_package
+
+    # TODO: Write general description for this method
+    # @return [ResponseBookedPackage]
+    attr_accessor :return_package
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['outbound_package'] = 'outbound_package'
+      @_hash['return_package'] = 'return_package'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        outbound_package
+        return_package
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        outbound_package
+        return_package
+      ]
+    end
+
+    def initialize(outbound_package = SKIP, return_package = SKIP)
+      @outbound_package = outbound_package unless outbound_package == SKIP
+      @return_package = return_package unless return_package == 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.
+      outbound_package = ResponseBookedPackage.from_hash(hash['outbound_package']) if
+        hash['outbound_package']
+      return_package = ResponseBookedPackage.from_hash(hash['return_package']) if
+        hash['return_package']
+
+      # Create object from extracted values.
+      ResponseBookedPackageTransaction.new(outbound_package,
+                                           return_package)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} outbound_package: #{@outbound_package}, return_package:"\
+      " #{@return_package}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} outbound_package: #{@outbound_package.inspect}, return_package:"\
+      " #{@return_package.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/response_create_bookings.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
+  # A single booking can map to one or more packages, mapping to one or more
+  # shipments. A few examples: * One Package, outbound only:     -> one booking
+  # -> one package -> one -outbound- shipment * One Package, outbound + return:
+  #    -> one booking -> one package -> one outbound shipment AND one return
+  # shipment * Two Packages, outbound + return:     -> one booking -> two
+  # packages -> for EACH PACKAGE, you will have one outbound and one return
+  # shipment.             -> total of 4 shipments (2 packages * (1 outbound
+  # shipment + 1 return shipment) = 4 shipments) * Three Packages, return only:
+  #    -> one booking -> three packages -> 1 return shipment for EACH package =
+  # 3 -return- shipments You noticed that no matter the case, there is always
+  # exactly ONE booking.
+  class ResponseCreateBookings < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [UUID | String]
+    attr_accessor :booking_id
+
+    # TODO: Write general description for this method
+    # @return [Array[ResponseBookedPackageTransaction]]
+    attr_accessor :bookings
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['booking_id'] = 'booking_id'
+      @_hash['bookings'] = 'bookings'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(booking_id = nil, bookings = nil)
+      @booking_id = booking_id
+      @bookings = bookings
+    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_id = hash.key?('booking_id') ? hash['booking_id'] : nil
+      # Parameter is an array, so we need to iterate through it
+      bookings = nil
+      unless hash['bookings'].nil?
+        bookings = []
+        hash['bookings'].each do |structure|
+          bookings << (ResponseBookedPackageTransaction.from_hash(structure) if structure)
+        end
+      end
+
+      bookings = nil unless hash.key?('bookings')
+
+      # Create object from extracted values.
+      ResponseCreateBookings.new(booking_id,
+                                 bookings)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} booking_id: #{@booking_id}, bookings: #{@bookings}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} booking_id: #{@booking_id.inspect}, bookings: #{@bookings.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/response_create_manifest.rb

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

data/lib/new_store_api/models/response_createconfigurationbyname.rb

@@ -0,0 +1,62 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # ResponseCreateconfigurationbyname Model.
+  class ResponseCreateconfigurationbyname < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # fulfillment node ID to customs signer config
+    # @return [Value]
+    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
+      %w[
+        value
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(value = SKIP)
+      @value = value unless value == 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.
+      value = Value.from_hash(hash['value']) if hash['value']
+
+      # Create object from extracted values.
+      ResponseCreateconfigurationbyname.new(value)
+    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/response_createjob.rb

@@ -0,0 +1,110 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module NewStoreApi
+  # ResponseCreatejob Model.
+  class ResponseCreatejob < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Job creation timestamp (ISO 8601 format)
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # Unique job identifier
+    # @return [String]
+    attr_accessor :job_id
+
+    # Query results data
+    # @return [Array[Object]]
+    attr_accessor :data
+
+    # Data format
+    # @return [String]
+    attr_accessor :format
+
+    # Job metadata including row_count, execution_time, and query_cost
+    # @return [Object]
+    attr_accessor :metadata
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['created_at'] = 'created_at'
+      @_hash['job_id'] = 'job_id'
+      @_hash['data'] = 'data'
+      @_hash['format'] = 'format'
+      @_hash['metadata'] = 'metadata'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        created_at
+        job_id
+        data
+        format
+        metadata
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(created_at = SKIP, job_id = SKIP, data = SKIP, format = SKIP,
+                   metadata = SKIP)
+      @created_at = created_at unless created_at == SKIP
+      @job_id = job_id unless job_id == SKIP
+      @data = data unless data == SKIP
+      @format = format unless format == SKIP
+      @metadata = metadata unless metadata == 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.
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   else
+                     SKIP
+                   end
+      job_id = hash.key?('job_id') ? hash['job_id'] : SKIP
+      data = hash.key?('data') ? hash['data'] : SKIP
+      format = hash.key?('format') ? hash['format'] : SKIP
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+
+      # Create object from extracted values.
+      ResponseCreatejob.new(created_at,
+                            job_id,
+                            data,
+                            format,
+                            metadata)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} created_at: #{@created_at}, job_id: #{@job_id}, data: #{@data}, format:"\
+      " #{@format}, metadata: #{@metadata}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} created_at: #{@created_at.inspect}, job_id: #{@job_id.inspect}, data:"\
+      " #{@data.inspect}, format: #{@format.inspect}, metadata: #{@metadata.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/response_delivery_window.rb

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