newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/audit_event.rb

@@ -0,0 +1,164 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module NewStoreApi
+  # A single audit log event.
+  class AuditEvent < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Who (or what) caused the audited change. Sourced from the caller's JWT;
+    # empty fields are omitted from the payload.
+    # @return [Actor]
+    attr_accessor :actor
+
+    # A point in time snapshot of the resource state before the change. Present
+    # for UPDATED and DELETED events.
+    # Unlike the rest of the event structure, the contents of this fields are
+    # not covered by the API's versioning and compatibility guarantees
+    # @return [Object]
+    attr_accessor :after
+
+    # A point in time snapshot of the resource state before the change. Present
+    # for UPDATED and DELETED events.
+    # Unlike the rest of the event structure, the contents of this fields are
+    # not covered by the API's versioning and compatibility guarantees
+    # @return [Object]
+    attr_accessor :before
+
+    # When the audited change occurred (RFC 3339).
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # Unique identifier for the audit log event (UUIDv4).
+    # @return [String]
+    attr_accessor :event_id
+
+    # Log-level discriminator for downstream aggregators; always "AUDIT".
+    # @return [String]
+    attr_reader :level
+
+    # The operation performed on the resource.
+    # @return [AuditOperationEnum]
+    attr_accessor :operation
+
+    # The HTTP request that carried the audited change.
+    # @return [RequestContext]
+    attr_accessor :request
+
+    # The type of resource affected.
+    # @return [String]
+    attr_accessor :resource
+
+    # Identifier of the specific resource affected.
+    # @return [String]
+    attr_accessor :resource_id
+
+    # Tenant the event belongs to.
+    # @return [String]
+    attr_accessor :tenant
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['actor'] = 'actor'
+      @_hash['after'] = 'after'
+      @_hash['before'] = 'before'
+      @_hash['created_at'] = 'created_at'
+      @_hash['event_id'] = 'event_id'
+      @_hash['level'] = 'level'
+      @_hash['operation'] = 'operation'
+      @_hash['request'] = 'request'
+      @_hash['resource'] = 'resource'
+      @_hash['resource_id'] = 'resource_id'
+      @_hash['tenant'] = 'tenant'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        after
+        before
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(actor = nil, created_at = nil, event_id = nil,
+                   operation = nil, request = nil, resource = nil,
+                   resource_id = nil, tenant = nil, after = SKIP, before = SKIP)
+      @actor = actor
+      @after = after unless after == SKIP
+      @before = before unless before == SKIP
+      @created_at = created_at
+      @event_id = event_id
+      @level = 'AUDIT'
+      @operation = operation
+      @request = request
+      @resource = resource
+      @resource_id = resource_id
+      @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.
+      actor = Actor.from_hash(hash['actor']) if hash['actor']
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   end
+      event_id = hash.key?('event_id') ? hash['event_id'] : nil
+      operation = hash.key?('operation') ? hash['operation'] : nil
+      request = RequestContext.from_hash(hash['request']) if hash['request']
+      resource = hash.key?('resource') ? hash['resource'] : nil
+      resource_id = hash.key?('resource_id') ? hash['resource_id'] : nil
+      tenant = hash.key?('tenant') ? hash['tenant'] : nil
+      after = hash.key?('after') ? hash['after'] : SKIP
+      before = hash.key?('before') ? hash['before'] : SKIP
+
+      # Create object from extracted values.
+      AuditEvent.new(actor,
+                     created_at,
+                     event_id,
+                     operation,
+                     request,
+                     resource,
+                     resource_id,
+                     tenant,
+                     after,
+                     before)
+    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} actor: #{@actor}, after: #{@after}, before: #{@before}, created_at:"\
+      " #{@created_at}, event_id: #{@event_id}, level: #{@level}, operation: #{@operation},"\
+      " request: #{@request}, resource: #{@resource}, resource_id: #{@resource_id}, tenant:"\
+      " #{@tenant}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} actor: #{@actor.inspect}, after: #{@after.inspect}, before:"\
+      " #{@before.inspect}, created_at: #{@created_at.inspect}, event_id: #{@event_id.inspect},"\
+      " level: #{@level.inspect}, operation: #{@operation.inspect}, request: #{@request.inspect},"\
+      " resource: #{@resource.inspect}, resource_id: #{@resource_id.inspect}, tenant:"\
+      " #{@tenant.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/audit_event_list.rb

@@ -0,0 +1,80 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # One page of audit log events, ordered newest first.
+  class AuditEventList < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The audit log events in this page, newest first.
+    # @return [Array[AuditEvent]]
+    attr_accessor :items
+
+    # Opaque cursor for the next page. Pass it back as the `cursor` query
+    # parameter to continue paging. Absent when the last page has been reached.
+    # @return [String]
+    attr_accessor :next_cursor
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['items'] = 'items'
+      @_hash['next_cursor'] = 'next_cursor'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        next_cursor
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(items = nil, next_cursor = SKIP)
+      @items = items
+      @next_cursor = next_cursor unless next_cursor == 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.
+      # Parameter is an array, so we need to iterate through it
+      items = nil
+      unless hash['items'].nil?
+        items = []
+        hash['items'].each do |structure|
+          items << (AuditEvent.from_hash(structure) if structure)
+        end
+      end
+
+      items = nil unless hash.key?('items')
+      next_cursor = hash.key?('next_cursor') ? hash['next_cursor'] : SKIP
+
+      # Create object from extracted values.
+      AuditEventList.new(items,
+                         next_cursor)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} items: #{@items}, next_cursor: #{@next_cursor}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} items: #{@items.inspect}, next_cursor: #{@next_cursor.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/audit_event_read_only.rb

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

data/lib/new_store_api/models/audit_operation_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 operation performed on the resource.
+  class AuditOperationEnum
+    AUDIT_OPERATION_ENUM = [
+      # TODO: Write general description for CREATED
+      CREATED = 'CREATED'.freeze,
+
+      # TODO: Write general description for UPDATED
+      UPDATED = 'UPDATED'.freeze,
+
+      # TODO: Write general description for DELETED
+      DELETED = 'DELETED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      AUDIT_OPERATION_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = CREATED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'created' then CREATED
+      when 'updated' then UPDATED
+      when 'deleted' then DELETED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/audit_read_only.rb

@@ -0,0 +1,133 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module NewStoreApi
+  # AuditReadOnly Model.
+  class AuditReadOnly < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # TODO: Write general description for this method
+    # @return [Array[AuditEventReadOnly]]
+    attr_accessor :events
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :request_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :search_key
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :tenant
+
+    # do NOT use this field in any way
+    # @return [Integer]
+    attr_accessor :version
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['created_at'] = 'created_at'
+      @_hash['events'] = 'events'
+      @_hash['id'] = 'id'
+      @_hash['request_id'] = 'request_id'
+      @_hash['search_key'] = 'search_key'
+      @_hash['tenant'] = 'tenant'
+      @_hash['version'] = 'version'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        version
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        search_key
+        version
+      ]
+    end
+
+    def initialize(created_at = nil, events = nil, id = nil, request_id = nil,
+                   search_key = nil, tenant = nil, version = SKIP)
+      @created_at = created_at
+      @events = events
+      @id = id
+      @request_id = request_id
+      @search_key = search_key
+      @tenant = tenant
+      @version = version unless version == 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'])
+                   end
+      # Parameter is an array, so we need to iterate through it
+      events = nil
+      unless hash['events'].nil?
+        events = []
+        hash['events'].each do |structure|
+          events << (AuditEventReadOnly.from_hash(structure) if structure)
+        end
+      end
+
+      events = nil unless hash.key?('events')
+      id = hash.key?('id') ? hash['id'] : nil
+      request_id = hash.key?('request_id') ? hash['request_id'] : nil
+      search_key = hash.key?('search_key') ? hash['search_key'] : nil
+      tenant = hash.key?('tenant') ? hash['tenant'] : nil
+      version = hash.key?('version') ? hash['version'] : SKIP
+
+      # Create object from extracted values.
+      AuditReadOnly.new(created_at,
+                        events,
+                        id,
+                        request_id,
+                        search_key,
+                        tenant,
+                        version)
+    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}, events: #{@events}, id: #{@id}, request_id:"\
+      " #{@request_id}, search_key: #{@search_key}, tenant: #{@tenant}, version: #{@version}>"
+    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}, events: #{@events.inspect}, id:"\
+      " #{@id.inspect}, request_id: #{@request_id.inspect}, search_key: #{@search_key.inspect},"\
+      " tenant: #{@tenant.inspect}, version: #{@version.inspect}>"
+    end
+  end
+end

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

data/lib/new_store_api/models/audits_response.rb

@@ -0,0 +1,77 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # AuditsResponse Model.
+  class AuditsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[AuditReadOnly]]
+    attr_accessor :audits
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :page_count
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['audits'] = 'audits'
+      @_hash['page_count'] = 'page_count'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(audits = nil, page_count = nil)
+      @audits = audits
+      @page_count = page_count
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      audits = nil
+      unless hash['audits'].nil?
+        audits = []
+        hash['audits'].each do |structure|
+          audits << (AuditReadOnly.from_hash(structure) if structure)
+        end
+      end
+
+      audits = nil unless hash.key?('audits')
+      page_count = hash.key?('page_count') ? hash['page_count'] : nil
+
+      # Create object from extracted values.
+      AuditsResponse.new(audits,
+                         page_count)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} audits: #{@audits}, page_count: #{@page_count}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} audits: #{@audits.inspect}, page_count: #{@page_count.inspect}>"
+    end
+  end
+end