ultracart_api 4.1.106 → 4.1.109

data/lib/ultracart_api/models/bulk_job.rb

@@ -0,0 +1,418 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+The version of the OpenAPI document: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.1-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module UltracartClient
+  class BulkJob
+    # When the job reached a terminal status
+    attr_accessor :completed_at
+
+    # Records short-circuited as duplicates
+    attr_accessor :duplicate_count
+
+    # Job-level failure code when status is failed
+    attr_accessor :error_code
+
+    # Records that failed
+    attr_accessor :fail_count
+
+    # Public-facing job id (uc-bulk-<ulid>)
+    attr_accessor :job_id
+
+    # Object type this job processes
+    attr_accessor :object
+
+    # Mutation mode this job runs (the bulk surface is write-only)
+    attr_accessor :operation
+
+    # Records processed so far
+    attr_accessor :processed_records
+
+    # Position behind the merchant's active job (queued jobs only)
+    attr_accessor :queue_position
+
+    # Presigned S3 URL to the full per-record results NDJSON (set when finished)
+    attr_accessor :results_summary_url
+
+    # When the worker started the job
+    attr_accessor :started_at
+
+    # Job status
+    attr_accessor :status
+
+    # When the job was submitted
+    attr_accessor :submitted_at
+
+    # Records that landed
+    attr_accessor :success_count
+
+    # Total records counted on the first pass (null until counted)
+    attr_accessor :total_records
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'completed_at' => :'completed_at',
+        :'duplicate_count' => :'duplicate_count',
+        :'error_code' => :'error_code',
+        :'fail_count' => :'fail_count',
+        :'job_id' => :'job_id',
+        :'object' => :'object',
+        :'operation' => :'operation',
+        :'processed_records' => :'processed_records',
+        :'queue_position' => :'queue_position',
+        :'results_summary_url' => :'results_summary_url',
+        :'started_at' => :'started_at',
+        :'status' => :'status',
+        :'submitted_at' => :'submitted_at',
+        :'success_count' => :'success_count',
+        :'total_records' => :'total_records'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'completed_at' => :'String',
+        :'duplicate_count' => :'Integer',
+        :'error_code' => :'String',
+        :'fail_count' => :'Integer',
+        :'job_id' => :'String',
+        :'object' => :'String',
+        :'operation' => :'String',
+        :'processed_records' => :'Integer',
+        :'queue_position' => :'Integer',
+        :'results_summary_url' => :'String',
+        :'started_at' => :'String',
+        :'status' => :'String',
+        :'submitted_at' => :'String',
+        :'success_count' => :'Integer',
+        :'total_records' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::BulkJob` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::BulkJob`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'completed_at')
+        self.completed_at = attributes[:'completed_at']
+      end
+
+      if attributes.key?(:'duplicate_count')
+        self.duplicate_count = attributes[:'duplicate_count']
+      end
+
+      if attributes.key?(:'error_code')
+        self.error_code = attributes[:'error_code']
+      end
+
+      if attributes.key?(:'fail_count')
+        self.fail_count = attributes[:'fail_count']
+      end
+
+      if attributes.key?(:'job_id')
+        self.job_id = attributes[:'job_id']
+      end
+
+      if attributes.key?(:'object')
+        self.object = attributes[:'object']
+      end
+
+      if attributes.key?(:'operation')
+        self.operation = attributes[:'operation']
+      end
+
+      if attributes.key?(:'processed_records')
+        self.processed_records = attributes[:'processed_records']
+      end
+
+      if attributes.key?(:'queue_position')
+        self.queue_position = attributes[:'queue_position']
+      end
+
+      if attributes.key?(:'results_summary_url')
+        self.results_summary_url = attributes[:'results_summary_url']
+      end
+
+      if attributes.key?(:'started_at')
+        self.started_at = attributes[:'started_at']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'submitted_at')
+        self.submitted_at = attributes[:'submitted_at']
+      end
+
+      if attributes.key?(:'success_count')
+        self.success_count = attributes[:'success_count']
+      end
+
+      if attributes.key?(:'total_records')
+        self.total_records = attributes[:'total_records']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      object_validator = EnumAttributeValidator.new('String', ["order", "customer"])
+      return false unless object_validator.valid?(@object)
+      operation_validator = EnumAttributeValidator.new('String', ["insert", "upsert"])
+      return false unless operation_validator.valid?(@operation)
+      status_validator = EnumAttributeValidator.new('String', ["queued", "in_progress", "succeeded", "partial_success", "failed", "cancelled"])
+      return false unless status_validator.valid?(@status)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] object Object to be assigned
+    def object=(object)
+      validator = EnumAttributeValidator.new('String', ["order", "customer"])
+      unless validator.valid?(object)
+        fail ArgumentError, "invalid value for \"object\", must be one of #{validator.allowable_values}."
+      end
+      @object = object
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] operation Object to be assigned
+    def operation=(operation)
+      validator = EnumAttributeValidator.new('String', ["insert", "upsert"])
+      unless validator.valid?(operation)
+        fail ArgumentError, "invalid value for \"operation\", must be one of #{validator.allowable_values}."
+      end
+      @operation = operation
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["queued", "in_progress", "succeeded", "partial_success", "failed", "cancelled"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          completed_at == o.completed_at &&
+          duplicate_count == o.duplicate_count &&
+          error_code == o.error_code &&
+          fail_count == o.fail_count &&
+          job_id == o.job_id &&
+          object == o.object &&
+          operation == o.operation &&
+          processed_records == o.processed_records &&
+          queue_position == o.queue_position &&
+          results_summary_url == o.results_summary_url &&
+          started_at == o.started_at &&
+          status == o.status &&
+          submitted_at == o.submitted_at &&
+          success_count == o.success_count &&
+          total_records == o.total_records
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [completed_at, duplicate_count, error_code, fail_count, job_id, object, operation, processed_records, queue_position, results_summary_url, started_at, status, submitted_at, success_count, total_records].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = UltracartClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/ultracart_api/models/bulk_job_request.rb

@@ -0,0 +1,284 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+The version of the OpenAPI document: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.1-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module UltracartClient
+  class BulkJobRequest
+    # Mutation mode - insert (create only) or upsert (create or update). Defaults to insert. This is always a mutation verb — the bulk surface writes only and has no read / query mode. upsert is currently supported for customer only.
+    attr_accessor :operation
+
+    # The s3_key returned by the upload-url endpoint
+    attr_accessor :s3_key
+
+    # Optional shared secret echoed in the completion POST's Authorization header
+    attr_accessor :webhook_secret
+
+    # Optional URL to POST once, on completion
+    attr_accessor :webhook_url
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'operation' => :'operation',
+        :'s3_key' => :'s3_key',
+        :'webhook_secret' => :'webhook_secret',
+        :'webhook_url' => :'webhook_url'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'operation' => :'String',
+        :'s3_key' => :'String',
+        :'webhook_secret' => :'String',
+        :'webhook_url' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::BulkJobRequest` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::BulkJobRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'operation')
+        self.operation = attributes[:'operation']
+      end
+
+      if attributes.key?(:'s3_key')
+        self.s3_key = attributes[:'s3_key']
+      end
+
+      if attributes.key?(:'webhook_secret')
+        self.webhook_secret = attributes[:'webhook_secret']
+      end
+
+      if attributes.key?(:'webhook_url')
+        self.webhook_url = attributes[:'webhook_url']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      operation_validator = EnumAttributeValidator.new('String', ["insert", "upsert"])
+      return false unless operation_validator.valid?(@operation)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] operation Object to be assigned
+    def operation=(operation)
+      validator = EnumAttributeValidator.new('String', ["insert", "upsert"])
+      unless validator.valid?(operation)
+        fail ArgumentError, "invalid value for \"operation\", must be one of #{validator.allowable_values}."
+      end
+      @operation = operation
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          operation == o.operation &&
+          s3_key == o.s3_key &&
+          webhook_secret == o.webhook_secret &&
+          webhook_url == o.webhook_url
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [operation, s3_key, webhook_secret, webhook_url].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = UltracartClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end