newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/recipients.rb

@@ -0,0 +1,82 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Recipients of the notification that might be a list of users or group by a
+  # custom topics. If more than one is set, the result is the intersection of
+  # them. They are technically filterd by the AND operator.
+  class Recipients < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Recipients in a specific app
+    # @return [String]
+    attr_accessor :app_name
+
+    # Recipients by subscriptions to a topics by name and value
+    # @return [Object]
+    attr_accessor :topics
+
+    # List of users who receive the notification
+    # @return [Array[String]]
+    attr_accessor :user_ids
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['app_name'] = 'app_name'
+      @_hash['topics'] = 'topics'
+      @_hash['user_ids'] = 'user_ids'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        topics
+        user_ids
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(app_name = nil, topics = SKIP, user_ids = SKIP)
+      @app_name = app_name
+      @topics = topics unless topics == SKIP
+      @user_ids = user_ids unless user_ids == 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.
+      app_name = hash.key?('app_name') ? hash['app_name'] : nil
+      topics = hash.key?('topics') ? hash['topics'] : SKIP
+      user_ids = hash.key?('user_ids') ? hash['user_ids'] : SKIP
+
+      # Create object from extracted values.
+      Recipients.new(app_name,
+                     topics,
+                     user_ids)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} app_name: #{@app_name}, topics: #{@topics}, user_ids: #{@user_ids}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} app_name: #{@app_name.inspect}, topics: #{@topics.inspect}, user_ids:"\
+      " #{@user_ids.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/registration_request.rb

@@ -0,0 +1,98 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # RegistrationRequest Model.
+  class RegistrationRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Identifier of the app name who recently used the device
+    # @return [String]
+    attr_accessor :app_name
+
+    # Identifier of the app os who recently used the device
+    # @return [String]
+    attr_accessor :app_os
+
+    # Registration or device id.
+    # @return [String]
+    attr_accessor :device_id
+
+    # Identifier of the store id who recently used the device
+    # @return [String]
+    attr_accessor :store_id
+
+    # Identifier of the user who recently used the device.
+    # @return [String]
+    attr_accessor :user_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['app_name'] = 'app_name'
+      @_hash['app_os'] = 'app_os'
+      @_hash['device_id'] = 'device_id'
+      @_hash['store_id'] = 'store_id'
+      @_hash['user_id'] = 'user_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        store_id
+        user_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(app_name = nil, app_os = nil, device_id = nil,
+                   store_id = SKIP, user_id = SKIP)
+      @app_name = app_name
+      @app_os = app_os
+      @device_id = device_id
+      @store_id = store_id unless store_id == SKIP
+      @user_id = user_id unless user_id == 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.
+      app_name = hash.key?('app_name') ? hash['app_name'] : nil
+      app_os = hash.key?('app_os') ? hash['app_os'] : nil
+      device_id = hash.key?('device_id') ? hash['device_id'] : nil
+      store_id = hash.key?('store_id') ? hash['store_id'] : SKIP
+      user_id = hash.key?('user_id') ? hash['user_id'] : SKIP
+
+      # Create object from extracted values.
+      RegistrationRequest.new(app_name,
+                              app_os,
+                              device_id,
+                              store_id,
+                              user_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} app_name: #{@app_name}, app_os: #{@app_os}, device_id: #{@device_id},"\
+      " store_id: #{@store_id}, user_id: #{@user_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} app_name: #{@app_name.inspect}, app_os: #{@app_os.inspect}, device_id:"\
+      " #{@device_id.inspect}, store_id: #{@store_id.inspect}, user_id: #{@user_id.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/registration_response.rb

@@ -0,0 +1,100 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # RegistrationResponse Model.
+  class RegistrationResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Identifier of the app name who recently used the device
+    # @return [String]
+    attr_accessor :app_name
+
+    # Identifier of the app OS who recently used the device
+    # @return [String]
+    attr_accessor :app_os
+
+    # Registration or device id.
+    # @return [String]
+    attr_accessor :device_id
+
+    # Identifier of the store id who recently used the device
+    # @return [String]
+    attr_accessor :store_id
+
+    # Identifier of the user who recently used the device.
+    # @return [String]
+    attr_accessor :user_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['app_name'] = 'app_name'
+      @_hash['app_os'] = 'app_os'
+      @_hash['device_id'] = 'device_id'
+      @_hash['store_id'] = 'store_id'
+      @_hash['user_id'] = 'user_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        app_name
+        app_os
+        store_id
+        user_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_id = nil, app_name = SKIP, app_os = SKIP,
+                   store_id = SKIP, user_id = SKIP)
+      @app_name = app_name unless app_name == SKIP
+      @app_os = app_os unless app_os == SKIP
+      @device_id = device_id
+      @store_id = store_id unless store_id == SKIP
+      @user_id = user_id unless user_id == 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.
+      device_id = hash.key?('device_id') ? hash['device_id'] : nil
+      app_name = hash.key?('app_name') ? hash['app_name'] : SKIP
+      app_os = hash.key?('app_os') ? hash['app_os'] : SKIP
+      store_id = hash.key?('store_id') ? hash['store_id'] : SKIP
+      user_id = hash.key?('user_id') ? hash['user_id'] : SKIP
+
+      # Create object from extracted values.
+      RegistrationResponse.new(device_id,
+                               app_name,
+                               app_os,
+                               store_id,
+                               user_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} app_name: #{@app_name}, app_os: #{@app_os}, device_id: #{@device_id},"\
+      " store_id: #{@store_id}, user_id: #{@user_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} app_name: #{@app_name.inspect}, app_os: #{@app_os.inspect}, device_id:"\
+      " #{@device_id.inspect}, store_id: #{@store_id.inspect}, user_id: #{@user_id.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/rejected_rerouting_settings.rb

@@ -0,0 +1,83 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module NewStoreApi
+  # RejectedReroutingSettings Model.
+  class RejectedReroutingSettings < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :updated_at
+
+    # Tells the routing engine if it should ignore fulfillment nodes that
+    # already rejected the fulfillment request at hand.
+    # @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.
+      RejectedReroutingSettings.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/remove.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
+  # Remove Model.
+  class Remove < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The operation to perform.
+    # @return [String]
+    attr_reader :op
+
+    # A JSON Pointer path.
+    # @return [String]
+    attr_accessor :path
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['op'] = 'op'
+      @_hash['path'] = 'path'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(path = nil)
+      @op = 'remove'
+      @path = path
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      path = hash.key?('path') ? hash['path'] : nil
+
+      # Create object from extracted values.
+      Remove.new(path)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Remove | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.op,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.path,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['op'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['path'],
+                                ->(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} op: #{@op}, path: #{@path}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} op: #{@op.inspect}, path: #{@path.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/remove_item_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
+  # RemoveItemResponseBody Model.
+  class RemoveItemResponseBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Informational messages
+    # @return [Array[String]]
+    attr_accessor :messages
+
+    # Warning messages
+    # @return [Array[String]]
+    attr_accessor :warnings
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['messages'] = 'messages'
+      @_hash['warnings'] = 'warnings'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        messages
+        warnings
+      ]
+    end
+
+    def initialize(messages = nil, warnings = nil)
+      @messages = messages
+      @warnings = warnings
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      messages = hash.key?('messages') ? hash['messages'] : nil
+      warnings = hash.key?('warnings') ? hash['warnings'] : nil
+
+      # Create object from extracted values.
+      RemoveItemResponseBody.new(messages,
+                                 warnings)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} messages: #{@messages}, warnings: #{@warnings}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} messages: #{@messages.inspect}, warnings: #{@warnings.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/replace_provider_rate_schema.rb

@@ -0,0 +1,127 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # ReplaceProviderRateSchema Model.
+  class ReplaceProviderRateSchema < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Carrier specific name that defines the service level. When defining
+    # provider rates with the same shipping provider, the value you specify here
+    # must be unique and should always match the name defined by the shipping
+    # provider API. For example, 'NextDayAirSaver' for UPS and
+    # 'GROUND_HOME_DELIVERY' for FedEx. If no value is provided, NewStore uses
+    # the unique identifier of the provider rate as the default value.
+    # @return [String]
+    attr_accessor :carrier_defined_service_level
+
+    # The ID for the provider rate used for the return shipment.
+    # @return [String]
+    attr_accessor :return_provider_rate_id
+
+    # Service level that the provider rate corresponds to.
+    # @return [String]
+    attr_accessor :service_level_id
+
+    # The name of shipping provider associated with this provider rate.
+    # @return [String]
+    attr_accessor :shipping_carrier_name
+
+    # Required for backwards compatibility purposes.
+    # @return [ProviderRateShippingTypeEnum]
+    attr_accessor :shipping_type
+
+    # Flag to indicate if the shipping provider cost is used instead of the
+    # service level cost defined in the fulfillment configuration. If set to
+    # true, the cost quoted by the shipping provider is displayed to the
+    # customer.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :use_as_customer_facing_cost
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['carrier_defined_service_level'] =
+        'carrier_defined_service_level'
+      @_hash['return_provider_rate_id'] = 'return_provider_rate_id'
+      @_hash['service_level_id'] = 'service_level_id'
+      @_hash['shipping_carrier_name'] = 'shipping_carrier_name'
+      @_hash['shipping_type'] = 'shipping_type'
+      @_hash['use_as_customer_facing_cost'] = 'use_as_customer_facing_cost'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        carrier_defined_service_level
+        return_provider_rate_id
+      ]
+    end
+
+    def initialize(carrier_defined_service_level = nil,
+                   return_provider_rate_id = nil, service_level_id = nil,
+                   shipping_carrier_name = nil, shipping_type = nil,
+                   use_as_customer_facing_cost = nil)
+      @carrier_defined_service_level = carrier_defined_service_level
+      @return_provider_rate_id = return_provider_rate_id
+      @service_level_id = service_level_id
+      @shipping_carrier_name = shipping_carrier_name
+      @shipping_type = shipping_type
+      @use_as_customer_facing_cost = use_as_customer_facing_cost
+    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_defined_service_level =
+        hash.key?('carrier_defined_service_level') ? hash['carrier_defined_service_level'] : nil
+      return_provider_rate_id =
+        hash.key?('return_provider_rate_id') ? hash['return_provider_rate_id'] : nil
+      service_level_id =
+        hash.key?('service_level_id') ? hash['service_level_id'] : nil
+      shipping_carrier_name =
+        hash.key?('shipping_carrier_name') ? hash['shipping_carrier_name'] : nil
+      shipping_type = hash.key?('shipping_type') ? hash['shipping_type'] : nil
+      use_as_customer_facing_cost =
+        hash.key?('use_as_customer_facing_cost') ? hash['use_as_customer_facing_cost'] : nil
+
+      # Create object from extracted values.
+      ReplaceProviderRateSchema.new(carrier_defined_service_level,
+                                    return_provider_rate_id,
+                                    service_level_id,
+                                    shipping_carrier_name,
+                                    shipping_type,
+                                    use_as_customer_facing_cost)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} carrier_defined_service_level: #{@carrier_defined_service_level},"\
+      " return_provider_rate_id: #{@return_provider_rate_id}, service_level_id:"\
+      " #{@service_level_id}, shipping_carrier_name: #{@shipping_carrier_name}, shipping_type:"\
+      " #{@shipping_type}, use_as_customer_facing_cost: #{@use_as_customer_facing_cost}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} carrier_defined_service_level: #{@carrier_defined_service_level.inspect},"\
+      " return_provider_rate_id: #{@return_provider_rate_id.inspect}, service_level_id:"\
+      " #{@service_level_id.inspect}, shipping_carrier_name: #{@shipping_carrier_name.inspect},"\
+      " shipping_type: #{@shipping_type.inspect}, use_as_customer_facing_cost:"\
+      " #{@use_as_customer_facing_cost.inspect}>"
+    end
+  end
+end