newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/create_cart_request_body.rb

@@ -0,0 +1,124 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # CreateCartRequestBody Model.
+  class CreateCartRequestBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Associate ID
+    # @return [String]
+    attr_accessor :associate_id
+
+    # Catalog name
+    # @return [String]
+    attr_accessor :catalog
+
+    # Channel ID (e.g. the store ID)
+    # @return [String]
+    attr_accessor :channel_id
+
+    # Channel type
+    # @return [String]
+    attr_reader :channel_type
+
+    # Currency
+    # @return [String]
+    attr_accessor :currency
+
+    # Customer ID
+    # @return [String]
+    attr_accessor :customer_id
+
+    # Device ID
+    # @return [String]
+    attr_accessor :device_id
+
+    # Catalog locale
+    # @return [String]
+    attr_accessor :locale
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['associate_id'] = 'associate_id'
+      @_hash['catalog'] = 'catalog'
+      @_hash['channel_id'] = 'channel_id'
+      @_hash['channel_type'] = 'channel_type'
+      @_hash['currency'] = 'currency'
+      @_hash['customer_id'] = 'customer_id'
+      @_hash['device_id'] = 'device_id'
+      @_hash['locale'] = 'locale'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        customer_id
+        device_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(associate_id = nil, catalog = nil, channel_id = nil,
+                   currency = nil, locale = nil, customer_id = SKIP,
+                   device_id = SKIP)
+      @associate_id = associate_id
+      @catalog = catalog
+      @channel_id = channel_id
+      @channel_type = 'STORE'
+      @currency = currency
+      @customer_id = customer_id unless customer_id == SKIP
+      @device_id = device_id unless device_id == SKIP
+      @locale = locale
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      associate_id = hash.key?('associate_id') ? hash['associate_id'] : nil
+      catalog = hash.key?('catalog') ? hash['catalog'] : nil
+      channel_id = hash.key?('channel_id') ? hash['channel_id'] : nil
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      locale = hash.key?('locale') ? hash['locale'] : nil
+      customer_id = hash.key?('customer_id') ? hash['customer_id'] : SKIP
+      device_id = hash.key?('device_id') ? hash['device_id'] : SKIP
+
+      # Create object from extracted values.
+      CreateCartRequestBody.new(associate_id,
+                                catalog,
+                                channel_id,
+                                currency,
+                                locale,
+                                customer_id,
+                                device_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} associate_id: #{@associate_id}, catalog: #{@catalog}, channel_id:"\
+      " #{@channel_id}, channel_type: #{@channel_type}, currency: #{@currency}, customer_id:"\
+      " #{@customer_id}, device_id: #{@device_id}, locale: #{@locale}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} associate_id: #{@associate_id.inspect}, catalog: #{@catalog.inspect},"\
+      " channel_id: #{@channel_id.inspect}, channel_type: #{@channel_type.inspect}, currency:"\
+      " #{@currency.inspect}, customer_id: #{@customer_id.inspect}, device_id:"\
+      " #{@device_id.inspect}, locale: #{@locale.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/create_data_request.rb

@@ -0,0 +1,79 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Create data request.
+  class CreateDataRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The file content to store.
+    # @return [Binary]
+    attr_accessor :content
+
+    # The media type of the content data.
+    # @return [String]
+    attr_accessor :content_type
+
+    # Time to live in days, will be kept indefinitely if not set.
+    # @return [Integer]
+    attr_accessor :ttl
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['content'] = 'content'
+      @_hash['content_type'] = 'content_type'
+      @_hash['ttl'] = 'ttl'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        ttl
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(content = nil, content_type = nil, ttl = SKIP)
+      @content = content
+      @content_type = content_type
+      @ttl = ttl unless ttl == 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.
+      content = hash.key?('content') ? hash['content'] : nil
+      content_type = hash.key?('content_type') ? hash['content_type'] : nil
+      ttl = hash.key?('ttl') ? hash['ttl'] : SKIP
+
+      # Create object from extracted values.
+      CreateDataRequest.new(content,
+                            content_type,
+                            ttl)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} content: #{@content}, content_type: #{@content_type}, ttl: #{@ttl}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} content: #{@content.inspect}, content_type: #{@content_type.inspect}, ttl:"\
+      " #{@ttl.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/create_data_response.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
+  # Store file response.
+  class CreateDataResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID for retriving the file content.
+    # @return [String]
+    attr_accessor :id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_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(id = nil)
+      @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.
+      id = hash.key?('id') ? hash['id'] : nil
+
+      # Create object from extracted values.
+      CreateDataResponse.new(id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/create_identity_provider_request.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
+  # Create an Identity Provider
+  class CreateIdentityProviderRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :config
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :enabled
+
+    # Supported Protocols for Identity Providers
+    # @return [IdentityProviderProtocolEnum]
+    attr_accessor :protocol
+
+    # Supported Vendors for Identity Providers
+    # @return [IdentityProviderVendorEnum]
+    attr_accessor :vendor
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['config'] = 'config'
+      @_hash['enabled'] = 'enabled'
+      @_hash['protocol'] = 'protocol'
+      @_hash['vendor'] = 'vendor'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        enabled
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(config = nil, protocol = nil, vendor = nil, enabled = true)
+      @config = config
+      @enabled = enabled unless enabled == SKIP
+      @protocol = protocol
+      @vendor = vendor
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      config = hash.key?('config') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateIdentityProviderRequestConfig), hash['config']
+      ) : nil
+      protocol = hash.key?('protocol') ? hash['protocol'] : nil
+      vendor = hash.key?('vendor') ? hash['vendor'] : nil
+      enabled = hash['enabled'] ||= true
+
+      # Create object from extracted values.
+      CreateIdentityProviderRequest.new(config,
+                                        protocol,
+                                        vendor,
+                                        enabled)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreateIdentityProviderRequest | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          UnionTypeLookUp.get(:CreateIdentityProviderRequestConfig)
+                         .validate(value.config) and
+            APIHelper.valid_type?(value.protocol,
+                                  ->(val) { IdentityProviderProtocolEnum.validate(val) }) and
+            APIHelper.valid_type?(value.vendor,
+                                  ->(val) { IdentityProviderVendorEnum.validate(val) })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        UnionTypeLookUp.get(:CreateIdentityProviderRequestConfig)
+                       .validate(value['config']) and
+          APIHelper.valid_type?(value['protocol'],
+                                ->(val) { IdentityProviderProtocolEnum.validate(val) }) and
+          APIHelper.valid_type?(value['vendor'],
+                                ->(val) { IdentityProviderVendorEnum.validate(val) })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} config: #{@config}, enabled: #{@enabled}, protocol: #{@protocol}, vendor:"\
+      " #{@vendor}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} config: #{@config.inspect}, enabled: #{@enabled.inspect}, protocol:"\
+      " #{@protocol.inspect}, vendor: #{@vendor.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/create_import_request.rb

@@ -0,0 +1,75 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # CreateImportRequest Model.
+  class CreateImportRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The human readable import identifier.
+    # @return [String]
+    attr_accessor :display_name
+
+    # The name of the CSV file that has been uploaded to the S3 bucket.
+    # @return [String]
+    attr_accessor :file_name
+
+    # The type of import.
+    # @return [String]
+    attr_reader :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['display_name'] = 'display_name'
+      @_hash['file_name'] = 'file_name'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(display_name = nil, file_name = nil)
+      @display_name = display_name
+      @file_name = file_name
+      @type = 'OUTREACH_LIST'
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      display_name = hash.key?('display_name') ? hash['display_name'] : nil
+      file_name = hash.key?('file_name') ? hash['file_name'] : nil
+
+      # Create object from extracted values.
+      CreateImportRequest.new(display_name,
+                              file_name)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} display_name: #{@display_name}, file_name: #{@file_name}, type: #{@type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} display_name: #{@display_name.inspect}, file_name: #{@file_name.inspect},"\
+      " type: #{@type.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/create_job_request.rb

@@ -0,0 +1,167 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module NewStoreApi
+  # Request model for creating a new export job.
+  class CreateJobRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Whether to compress the export files (GZIP compression)
+    # @return [TrueClass | FalseClass]
+    attr_accessor :compressed
+
+    # A collection of conditions, implicitly joined by AND.
+    # @return [Conditions]
+    attr_accessor :conditions
+
+    # Dataset identifier to export
+    # @return [String]
+    attr_accessor :dataset
+
+    # Optional list of fields to export. If not provided, all fields will be
+    # exported.
+    # @return [Object]
+    attr_accessor :fields
+
+    # Execution mode: 'sync' for immediate results, 'async' for background
+    # processing
+    # @return [String]
+    attr_accessor :mode
+
+    # End of the export period (ISO 8601 format)
+    # @return [DateTime]
+    attr_accessor :period_end
+
+    # Start of the export period (ISO 8601 format)
+    # @return [DateTime]
+    attr_accessor :period_start
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['compressed'] = 'compressed'
+      @_hash['conditions'] = 'conditions'
+      @_hash['dataset'] = 'dataset'
+      @_hash['fields'] = 'fields'
+      @_hash['mode'] = 'mode'
+      @_hash['period_end'] = 'period_end'
+      @_hash['period_start'] = 'period_start'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        compressed
+        fields
+        mode
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(conditions = nil, dataset = nil, period_end = nil,
+                   period_start = nil, compressed = false, fields = SKIP,
+                   mode = 'async')
+      @compressed = compressed unless compressed == SKIP
+      @conditions = conditions
+      @dataset = dataset
+      @fields = fields unless fields == SKIP
+      @mode = mode unless mode == SKIP
+      @period_end = period_end
+      @period_start = period_start
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      conditions = Conditions.from_hash(hash['conditions']) if hash['conditions']
+      dataset = hash.key?('dataset') ? hash['dataset'] : nil
+      period_end = if hash.key?('period_end')
+                     (DateTimeHelper.from_rfc3339(hash['period_end']) if hash['period_end'])
+                   end
+      period_start = if hash.key?('period_start')
+                       (DateTimeHelper.from_rfc3339(hash['period_start']) if hash['period_start'])
+                     end
+      compressed = hash['compressed'] ||= false
+      fields = hash.key?('fields') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateJobRequestFields), hash['fields']
+      ) : SKIP
+      mode = hash['mode'] ||= 'async'
+
+      # Create object from extracted values.
+      CreateJobRequest.new(conditions,
+                           dataset,
+                           period_end,
+                           period_start,
+                           compressed,
+                           fields,
+                           mode)
+    end
+
+    def to_custom_period_end
+      DateTimeHelper.to_rfc3339(period_end)
+    end
+
+    def to_custom_period_start
+      DateTimeHelper.to_rfc3339(period_start)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreateJobRequest | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.conditions,
+                                ->(val) { Conditions.validate(val) },
+                                is_model_hash: true) and
+            APIHelper.valid_type?(value.dataset,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.period_end,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.period_start,
+                                  ->(val) { val.instance_of? DateTime })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['conditions'],
+                              ->(val) { Conditions.validate(val) },
+                              is_model_hash: true) and
+          APIHelper.valid_type?(value['dataset'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['period_end'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['period_start'],
+                                ->(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} compressed: #{@compressed}, conditions: #{@conditions}, dataset:"\
+      " #{@dataset}, fields: #{@fields}, mode: #{@mode}, period_end: #{@period_end}, period_start:"\
+      " #{@period_start}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} compressed: #{@compressed.inspect}, conditions: #{@conditions.inspect},"\
+      " dataset: #{@dataset.inspect}, fields: #{@fields.inspect}, mode: #{@mode.inspect},"\
+      " period_end: #{@period_end.inspect}, period_start: #{@period_start.inspect}>"
+    end
+  end
+end