newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/operation1_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
+  # operation1.
+  class Operation1Enum
+    OPERATION1_ENUM = [
+      # TODO: Write general description for TOKENIZE
+      TOKENIZE = 'tokenize'.freeze,
+
+      # TODO: Write general description for DETOKENIZE
+      DETOKENIZE = 'detokenize'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      OPERATION1_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = TOKENIZE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'tokenize' then TOKENIZE
+      when 'detokenize' then DETOKENIZE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/operation_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
+  # operation.
+  class OperationEnum
+    OPERATION_ENUM = [
+      # TODO: Write general description for ASSIGN
+      ASSIGN = 'assign'.freeze,
+
+      # TODO: Write general description for UNASSIGN
+      UNASSIGN = 'unassign'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      OPERATION_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ASSIGN)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'assign' then ASSIGN
+      when 'unassign' then UNASSIGN
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/operation_error.rb

@@ -0,0 +1,68 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Details of a backend service failure during operation execution.
+  class OperationError < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Error message from the failing service.
+    # @return [String]
+    attr_accessor :message
+
+    # The backend service that failed.
+    # @return [String]
+    attr_accessor :service
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['message'] = 'message'
+      @_hash['service'] = 'service'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(message = nil, service = nil)
+      @message = message
+      @service = service
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      message = hash.key?('message') ? hash['message'] : nil
+      service = hash.key?('service') ? hash['service'] : nil
+
+      # Create object from extracted values.
+      OperationError.new(message,
+                         service)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} message: #{@message}, service: #{@service}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} message: #{@message.inspect}, service: #{@service.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/operation_response.rb

@@ -0,0 +1,125 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module NewStoreApi
+  # Status and details of an asynchronous write operation.
+  class OperationResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Timestamp when the operation was created.
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # Details of a backend service failure during operation execution.
+    # @return [OperationError]
+    attr_accessor :error
+
+    # Unique operation identifier.
+    # @return [String]
+    attr_accessor :id
+
+    # The new settings version after successful completion (e.g. "v43"). Only
+    # present when status is "completed".
+    # @return [String]
+    attr_accessor :result_version
+
+    # Lifecycle stage of an async write operation.
+    # @return [OperationStatusEnum]
+    attr_accessor :status
+
+    # Store targeted by this operation. Absent for global writes.
+    # @return [String]
+    attr_accessor :store_id
+
+    # Tenant that owns this operation.
+    # @return [String]
+    attr_accessor :tenant_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['created_at'] = 'created_at'
+      @_hash['error'] = 'error'
+      @_hash['id'] = 'id'
+      @_hash['result_version'] = 'result_version'
+      @_hash['status'] = 'status'
+      @_hash['store_id'] = 'store_id'
+      @_hash['tenant_id'] = 'tenant_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        error
+        result_version
+        store_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(created_at = nil, id = nil, status = nil, tenant_id = nil,
+                   error = SKIP, result_version = SKIP, store_id = SKIP)
+      @created_at = created_at
+      @error = error unless error == SKIP
+      @id = id
+      @result_version = result_version unless result_version == SKIP
+      @status = status
+      @store_id = store_id unless store_id == SKIP
+      @tenant_id = tenant_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.
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   end
+      id = hash.key?('id') ? hash['id'] : nil
+      status = hash.key?('status') ? hash['status'] : nil
+      tenant_id = hash.key?('tenant_id') ? hash['tenant_id'] : nil
+      error = OperationError.from_hash(hash['error']) if hash['error']
+      result_version =
+        hash.key?('result_version') ? hash['result_version'] : SKIP
+      store_id = hash.key?('store_id') ? hash['store_id'] : SKIP
+
+      # Create object from extracted values.
+      OperationResponse.new(created_at,
+                            id,
+                            status,
+                            tenant_id,
+                            error,
+                            result_version,
+                            store_id)
+    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}, error: #{@error}, id: #{@id}, result_version:"\
+      " #{@result_version}, status: #{@status}, store_id: #{@store_id}, tenant_id: #{@tenant_id}>"
+    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}, error: #{@error.inspect}, id:"\
+      " #{@id.inspect}, result_version: #{@result_version.inspect}, status: #{@status.inspect},"\
+      " store_id: #{@store_id.inspect}, tenant_id: #{@tenant_id.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/operation_status_enum.rb

@@ -0,0 +1,48 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Lifecycle stage of an async write operation.
+  class OperationStatusEnum
+    OPERATION_STATUS_ENUM = [
+      # TODO: Write general description for PENDING
+      PENDING = 'pending'.freeze,
+
+      # TODO: Write general description for EXECUTING
+      EXECUTING = 'executing'.freeze,
+
+      # TODO: Write general description for COMPLETED
+      COMPLETED = 'completed'.freeze,
+
+      # TODO: Write general description for ROLLED_BACK
+      ROLLED_BACK = 'rolled_back'.freeze,
+
+      # TODO: Write general description for ROLLBACK_FAILED
+      ROLLBACK_FAILED = 'rollback_failed'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      OPERATION_STATUS_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = PENDING)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'pending' then PENDING
+      when 'executing' then EXECUTING
+      when 'completed' then COMPLETED
+      when 'rolled_back' then ROLLED_BACK
+      when 'rollback_failed' then ROLLBACK_FAILED
+      else
+        default_value
+      end
+    end
+  end
+end

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

data/lib/new_store_api/models/operator_enum.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
+  # Supported filter operators.
+  class OperatorEnum
+    OPERATOR_ENUM = [
+      # TODO: Write general description for ENUM_0
+      ENUM_0 = '='.freeze,
+
+      # TODO: Write general description for ENUM_1
+      ENUM_1 = '!='.freeze,
+
+      # TODO: Write general description for ENUM_2
+      ENUM_2 = '>'.freeze,
+
+      # TODO: Write general description for ENUM_3
+      ENUM_3 = '>='.freeze,
+
+      # TODO: Write general description for ENUM_4
+      ENUM_4 = '<'.freeze,
+
+      # TODO: Write general description for ENUM_5
+      ENUM_5 = '<='.freeze,
+
+      # TODO: Write general description for ENUM_6
+      ENUM_6 = 'LIKE'.freeze,
+
+      # TODO: Write general description for ENUM_7
+      ENUM_7 = 'IN'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      OPERATOR_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENUM_0)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enum_0' then ENUM_0
+      when 'enum_1' then ENUM_1
+      when 'enum_2' then ENUM_2
+      when 'enum_3' then ENUM_3
+      when 'enum_4' then ENUM_4
+      when 'enum_5' then ENUM_5
+      when 'enum_6' then ENUM_6
+      when 'enum_7' then ENUM_7
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/opt_in_state_enum.rb

@@ -0,0 +1,40 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # The current opt-in state for this store.
+  class OptInStateEnum
+    OPT_IN_STATE_ENUM = [
+      # TODO: Write general description for ACCEPTED
+      ACCEPTED = 'accepted'.freeze,
+
+      # TODO: Write general description for WAITING
+      WAITING = 'waiting'.freeze,
+
+      # TODO: Write general description for REJECTED
+      REJECTED = 'rejected'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      OPT_IN_STATE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ACCEPTED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'accepted' then ACCEPTED
+      when 'waiting' then WAITING
+      when 'rejected' then REJECTED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/opted_in.rb

@@ -0,0 +1,77 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module NewStoreApi
+  # Opt-in status information for a conversation between a customer and a store.
+  class OptedIn < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The current opt-in state for this store.
+    # @return [OptInStateEnum]
+    attr_accessor :opt_in_state
+
+    # Timestamp when the opt-in state was last modified.
+    # @return [DateTime]
+    attr_accessor :opt_in_state_modified_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['opt_in_state'] = 'opt_in_state'
+      @_hash['opt_in_state_modified_at'] = 'opt_in_state_modified_at'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(opt_in_state = nil, opt_in_state_modified_at = nil)
+      @opt_in_state = opt_in_state
+      @opt_in_state_modified_at = opt_in_state_modified_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.
+      opt_in_state = hash.key?('opt_in_state') ? hash['opt_in_state'] : nil
+      opt_in_state_modified_at = if hash.key?('opt_in_state_modified_at')
+                                   (DateTimeHelper.from_rfc3339(hash['opt_in_state_modified_at']) if hash['opt_in_state_modified_at'])
+                                 end
+
+      # Create object from extracted values.
+      OptedIn.new(opt_in_state,
+                  opt_in_state_modified_at)
+    end
+
+    def to_custom_opt_in_state_modified_at
+      DateTimeHelper.to_rfc3339(opt_in_state_modified_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} opt_in_state: #{@opt_in_state}, opt_in_state_modified_at:"\
+      " #{@opt_in_state_modified_at}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} opt_in_state: #{@opt_in_state.inspect}, opt_in_state_modified_at:"\
+      " #{@opt_in_state_modified_at.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/option_product_customs.rb

@@ -0,0 +1,107 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # OptionProductCustoms Model.
+  class OptionProductCustoms < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :description
+
+    # HTS (10-digit) or HS (6-digit) number. dots are allowed. prefer HTS
+    # numbers. compatibility with HS number exists for historical reasons. See
+    # https://www.trade.gov/harmonized-system-hs-codes
+    # @return [String]
+    attr_accessor :hts_number
+
+    # Alpha2 Country Code. We allow more for historical reasons.
+    # @return [String]
+    attr_accessor :origin_country
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['description'] = 'description'
+      @_hash['hts_number'] = 'hts_number'
+      @_hash['origin_country'] = 'origin_country'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(description = nil, hts_number = nil, origin_country = nil)
+      @description = description
+      @hts_number = hts_number
+      @origin_country = origin_country
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      description = hash.key?('description') ? hash['description'] : nil
+      hts_number = hash.key?('hts_number') ? hash['hts_number'] : nil
+      origin_country =
+        hash.key?('origin_country') ? hash['origin_country'] : nil
+
+      # Create object from extracted values.
+      OptionProductCustoms.new(description,
+                               hts_number,
+                               origin_country)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [OptionProductCustoms | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.description,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.hts_number,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.origin_country,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['description'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['hts_number'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['origin_country'],
+                                ->(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} description: #{@description}, hts_number: #{@hts_number}, origin_country:"\
+      " #{@origin_country}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} description: #{@description.inspect}, hts_number: #{@hts_number.inspect},"\
+      " origin_country: #{@origin_country.inspect}>"
+    end
+  end
+end