newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/percentage_discount.rb

@@ -0,0 +1,169 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # A percentage discount.
+  class PercentageDiscount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The discount amount applied to this line item, in the currency's minor
+    # unit. For a discount prorated from an order-level promotion, this is only
+    # this line's share.
+    # @return [Integer]
+    attr_accessor :applied_amount
+
+    # The coupon code that triggered the discount, when one was used.
+    # @return [String]
+    attr_accessor :coupon_code
+
+    # Human-readable description of why the discount was applied.
+    # @return [String]
+    attr_accessor :description
+
+    # To identify the discount in the external system.
+    # @return [String]
+    attr_accessor :external_reference
+
+    # ID of the discount; shared across all lines from the same promotion so
+    # downstream can aggregate them.
+    # @return [UUID | String]
+    attr_accessor :id
+
+    # The discount percentage (0-100).
+    # @return [Float]
+    attr_accessor :rate
+
+    # Whether the discount was applied at the item level or prorated from an
+    # order-level discount.
+    # @return [LevelEnum]
+    attr_accessor :scope
+
+    # Discriminates a percentage discount.
+    # @return [String]
+    attr_reader :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['applied_amount'] = 'applied_amount'
+      @_hash['coupon_code'] = 'coupon_code'
+      @_hash['description'] = 'description'
+      @_hash['external_reference'] = 'external_reference'
+      @_hash['id'] = 'id'
+      @_hash['rate'] = 'rate'
+      @_hash['scope'] = 'scope'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        coupon_code
+        description
+        external_reference
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        coupon_code
+        description
+        external_reference
+      ]
+    end
+
+    def initialize(applied_amount = nil, id = nil, rate = nil, scope = nil,
+                   coupon_code = SKIP, description = SKIP,
+                   external_reference = SKIP)
+      @applied_amount = applied_amount
+      @coupon_code = coupon_code unless coupon_code == SKIP
+      @description = description unless description == SKIP
+      @external_reference = external_reference unless external_reference == SKIP
+      @id = id
+      @rate = rate
+      @scope = scope
+      @type = 'percentage'
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      applied_amount =
+        hash.key?('applied_amount') ? hash['applied_amount'] : nil
+      id = hash.key?('id') ? hash['id'] : nil
+      rate = hash.key?('rate') ? hash['rate'] : nil
+      scope = hash.key?('scope') ? hash['scope'] : nil
+      coupon_code = hash.key?('coupon_code') ? hash['coupon_code'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      external_reference =
+        hash.key?('external_reference') ? hash['external_reference'] : SKIP
+
+      # Create object from extracted values.
+      PercentageDiscount.new(applied_amount,
+                             id,
+                             rate,
+                             scope,
+                             coupon_code,
+                             description,
+                             external_reference)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PercentageDiscount | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.applied_amount,
+                                ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.id,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.rate,
+                                  ->(val) { val.instance_of? Float }) and
+            APIHelper.valid_type?(value.scope,
+                                  ->(val) { LevelEnum.validate(val) }) and
+            APIHelper.valid_type?(value.type,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['applied_amount'],
+                              ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['id'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['rate'],
+                                ->(val) { val.instance_of? Float }) and
+          APIHelper.valid_type?(value['scope'],
+                                ->(val) { LevelEnum.validate(val) }) and
+          APIHelper.valid_type?(value['type'],
+                                ->(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} applied_amount: #{@applied_amount}, coupon_code: #{@coupon_code},"\
+      " description: #{@description}, external_reference: #{@external_reference}, id: #{@id},"\
+      " rate: #{@rate}, scope: #{@scope}, type: #{@type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} applied_amount: #{@applied_amount.inspect}, coupon_code:"\
+      " #{@coupon_code.inspect}, description: #{@description.inspect}, external_reference:"\
+      " #{@external_reference.inspect}, id: #{@id.inspect}, rate: #{@rate.inspect}, scope:"\
+      " #{@scope.inspect}, type: #{@type.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/period_type_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
+  # Period of the report.
+  class PeriodTypeEnum
+    PERIOD_TYPE_ENUM = [
+      # TODO: Write general description for SHIFTREPORT
+      SHIFTREPORT = 'shift-report'.freeze,
+
+      # TODO: Write general description for DAYREPORT
+      DAYREPORT = 'day-report'.freeze,
+
+      # TODO: Write general description for MONTHREPORT
+      MONTHREPORT = 'month-report'.freeze,
+
+      # TODO: Write general description for YEARREPORT
+      YEARREPORT = 'year-report'.freeze,
+
+      # TODO: Write general description for GRANDTOTALSREPORT
+      GRANDTOTALSREPORT = 'grand-totals-report'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PERIOD_TYPE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = SHIFTREPORT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'shiftreport' then SHIFTREPORT
+      when 'dayreport' then DAYREPORT
+      when 'monthreport' then MONTHREPORT
+      when 'yearreport' then YEARREPORT
+      when 'grandtotalsreport' then GRANDTOTALSREPORT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/permalink_response.rb

@@ -0,0 +1,72 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # PermalinkResponse Model.
+  class PermalinkResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The URL of the document.
+    # @return [String]
+    attr_accessor :permanent_link
+
+    # ID of the document in the PII vault
+    # @return [String]
+    attr_accessor :vault_data_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['permanent_link'] = 'permanent_link'
+      @_hash['vault_data_id'] = 'vault_data_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        vault_data_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(permanent_link = nil, vault_data_id = SKIP)
+      @permanent_link = permanent_link
+      @vault_data_id = vault_data_id unless vault_data_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.
+      permanent_link =
+        hash.key?('permanent_link') ? hash['permanent_link'] : nil
+      vault_data_id = hash.key?('vault_data_id') ? hash['vault_data_id'] : SKIP
+
+      # Create object from extracted values.
+      PermalinkResponse.new(permanent_link,
+                            vault_data_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} permanent_link: #{@permanent_link}, vault_data_id: #{@vault_data_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} permanent_link: #{@permanent_link.inspect}, vault_data_id:"\
+      " #{@vault_data_id.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/permission.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
+  # List of all available system permissions.
+  class Permission < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Abbreviation of the application this permission belongs to.
+    # @return [ApplicationEnum]
+    attr_accessor :application
+
+    # Nested list of child permissions.
+    # @return [Array[Permission]]
+    attr_accessor :children
+
+    # Name of the permission.
+    # @return [String]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['application'] = 'application'
+      @_hash['children'] = 'children'
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        children
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(application = nil, name = nil, children = SKIP)
+      @application = application
+      @children = children unless children == SKIP
+      @name = name
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      application = hash.key?('application') ? hash['application'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      # Parameter is an array, so we need to iterate through it
+      children = nil
+      unless hash['children'].nil?
+        children = []
+        hash['children'].each do |structure|
+          children << (Permission.from_hash(structure) if structure)
+        end
+      end
+
+      children = SKIP unless hash.key?('children')
+
+      # Create object from extracted values.
+      Permission.new(application,
+                     name,
+                     children)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} application: #{@application}, children: #{@children}, name: #{@name}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} application: #{@application.inspect}, children: #{@children.inspect}, name:"\
+      " #{@name.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/platform_event_dto.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
+  # PlatformEventDto Model.
+  class PlatformEventDto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the external event.
+    # @return [EventName1Enum]
+    attr_accessor :name
+
+    # The name of the external event.
+    # @return [Object]
+    attr_accessor :payload
+
+    # Timestamp of the publishing of the event.
+    # @return [DateTime]
+    attr_accessor :published_at
+
+    # Tenant identifier.
+    # @return [String]
+    attr_accessor :tenant
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['payload'] = 'payload'
+      @_hash['published_at'] = 'published_at'
+      @_hash['tenant'] = 'tenant'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = nil, payload = nil, published_at = nil, tenant = nil)
+      @name = name
+      @payload = payload
+      @published_at = published_at
+      @tenant = tenant
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      name = hash.key?('name') ? hash['name'] : nil
+      payload = hash.key?('payload') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:PlatformEventDtoPayload), hash['payload']
+      ) : nil
+      published_at = if hash.key?('published_at')
+                       (DateTimeHelper.from_rfc3339(hash['published_at']) if hash['published_at'])
+                     end
+      tenant = hash.key?('tenant') ? hash['tenant'] : nil
+
+      # Create object from extracted values.
+      PlatformEventDto.new(name,
+                           payload,
+                           published_at,
+                           tenant)
+    end
+
+    def to_custom_published_at
+      DateTimeHelper.to_rfc3339(published_at)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PlatformEventDto | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.name,
+                                ->(val) { EventName1Enum.validate(val) }) and
+            UnionTypeLookUp.get(:PlatformEventDtoPayload)
+                           .validate(value.payload) and
+            APIHelper.valid_type?(value.published_at,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.tenant,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['name'],
+                              ->(val) { EventName1Enum.validate(val) }) and
+          UnionTypeLookUp.get(:PlatformEventDtoPayload)
+                         .validate(value['payload']) and
+          APIHelper.valid_type?(value['published_at'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['tenant'],
+                                ->(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} name: #{@name}, payload: #{@payload}, published_at: #{@published_at},"\
+      " tenant: #{@tenant}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, payload: #{@payload.inspect}, published_at:"\
+      " #{@published_at.inspect}, tenant: #{@tenant.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/platform_status_enum.rb

@@ -0,0 +1,44 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # PlatformStatus.
+  class PlatformStatusEnum
+    PLATFORM_STATUS_ENUM = [
+      # TODO: Write general description for UNKNOWN
+      UNKNOWN = 'UNKNOWN'.freeze,
+
+      # TODO: Write general description for HEALTHY
+      HEALTHY = 'HEALTHY'.freeze,
+
+      # TODO: Write general description for DEGRADED
+      DEGRADED = 'DEGRADED'.freeze,
+
+      # TODO: Write general description for UNAVAILABLE
+      UNAVAILABLE = 'UNAVAILABLE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PLATFORM_STATUS_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = UNKNOWN)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'unknown' then UNKNOWN
+      when 'healthy' then HEALTHY
+      when 'degraded' then DEGRADED
+      when 'unavailable' then UNAVAILABLE
+      else
+        default_value
+      end
+    end
+  end
+end

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