printful_client 1.0.1

data/lib/printful_client/models/template.rb

@@ -0,0 +1,372 @@
+=begin
+#API Documentation | Printful
+
+## About the Printful API  The Printful API is a RESTful API, that uses an HTTP protocol for communication. HTTP GET, POST, PUT and DELETE methods are used to access the API resources.  ## Requests and responses  ### Request endpoint All API requests have to be sent to this URL: ``` https://api.printful.com/ ``` If you are using a proxy, make sure that all requests have host header set to **api.printful.com**.  ### Request parameters Some mandatory parameters (like object identifiers) must be included in the request URL path ``` GET /orders/123 ``` Additional parameters can be passed as GET variables: ``` GET /orders?offset=10&limit=5 ``` For POST and PUT requests, a more complex data structure can be passed as JSON encoded data in the request body: ``` POST /orders  {\"recipient\":{...},\"items\":[...]} ```  ### Response body The response body is always a JSON object that contains a response status code (identical to the HTTP status code) and the result of the action. If the status code is 200, then the action was successful. ``` {    \"code\": 200, //Response status code    \"result\":{       //API method return data    //...    } } ```  Sometimes the response includes paging information to allow to browse larger result sets by adding offset and limit GET parameters to the request URL. ``` {    \"code\": 200, //Response status code    \"result\":[     {        //Item 11     },     {        //Item 12     }    ]    \"paging\": {       \"total\": 12,  //Total items available       \"offset\": 10, //Items skipped from the beginning       \"limit\": 20   //Number of items per page    } } ```  ## Error response If the API call is not successful, then the response code is not in the 2xx range and the `result` attribute contains an error description. ``` {     \"code\": 404,     \"result\": \"Not Found\",     \"error\": {         \"reason\": \"NotFound\",         \"message\": \"Not Found\"     } } ```  In general, response codes in the 4xx range indicate an error that resulted from the provided information (e.g. a required parameter was missing, etc.), and codes in the 5xx range indicate an error with Printful's servers.  ### Timestamps All timestamps from the API are returned as integers in UNIX timestamp format.  ### Rate Limits Printful API has a general rate limit of 120 API calls per minute. Additionally, endpoints that perform resource intensive operations (such as mockup generator) have a lower allowed request limit.  # Authentication  <!-- ReDoc-Inject: <security-definitions> -->
+
+The version of the OpenAPI document: 1.0
+Contact: devsupport@printful.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.0.0-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module Printful
+  # Template variant mapping
+  class Template
+    # Template ID.
+    attr_accessor :template_id
+
+    # Main template image URL.
+    attr_accessor :image_url
+
+    # Background image URL (optional).
+    attr_accessor :background_url
+
+    # HEX color code that should be used as a background color.
+    attr_accessor :background_color
+
+    # Printfile ID that should be generated for this template. See [printfile API endpoint](#operation/getPrintfiles) for list of Printfiles.
+    attr_accessor :printfile_id
+
+    # Width of the whole template in pixels.
+    attr_accessor :template_width
+
+    # Height of the whole template in pixels.
+    attr_accessor :template_height
+
+    # Print area width (image is positioned in this area).
+    attr_accessor :print_area_width
+
+    # Print area height (image is positioned in this area).
+    attr_accessor :print_area_height
+
+    # Print area top offset (offset in template).
+    attr_accessor :print_area_top
+
+    # Print area left offset (offset in template).
+    attr_accessor :print_area_left
+
+    # Should the main template image (image_url) be used as an overlay or as a background.
+    attr_accessor :is_template_on_front
+
+    # Wall art product orientation. Possible values: horizontal, vertical, any
+    attr_accessor :orientation
+
+    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
+      {
+        :'template_id' => :'template_id',
+        :'image_url' => :'image_url',
+        :'background_url' => :'background_url',
+        :'background_color' => :'background_color',
+        :'printfile_id' => :'printfile_id',
+        :'template_width' => :'template_width',
+        :'template_height' => :'template_height',
+        :'print_area_width' => :'print_area_width',
+        :'print_area_height' => :'print_area_height',
+        :'print_area_top' => :'print_area_top',
+        :'print_area_left' => :'print_area_left',
+        :'is_template_on_front' => :'is_template_on_front',
+        :'orientation' => :'orientation'
+      }
+    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
+      {
+        :'template_id' => :'Integer',
+        :'image_url' => :'String',
+        :'background_url' => :'String',
+        :'background_color' => :'Integer',
+        :'printfile_id' => :'Integer',
+        :'template_width' => :'Integer',
+        :'template_height' => :'Integer',
+        :'print_area_width' => :'Integer',
+        :'print_area_height' => :'Integer',
+        :'print_area_top' => :'Integer',
+        :'print_area_left' => :'Integer',
+        :'is_template_on_front' => :'Boolean',
+        :'orientation' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'background_url',
+        :'background_color',
+      ])
+    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 `Printful::Template` 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 `Printful::Template`. 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?(:'template_id')
+        self.template_id = attributes[:'template_id']
+      end
+
+      if attributes.key?(:'image_url')
+        self.image_url = attributes[:'image_url']
+      end
+
+      if attributes.key?(:'background_url')
+        self.background_url = attributes[:'background_url']
+      end
+
+      if attributes.key?(:'background_color')
+        self.background_color = attributes[:'background_color']
+      end
+
+      if attributes.key?(:'printfile_id')
+        self.printfile_id = attributes[:'printfile_id']
+      end
+
+      if attributes.key?(:'template_width')
+        self.template_width = attributes[:'template_width']
+      end
+
+      if attributes.key?(:'template_height')
+        self.template_height = attributes[:'template_height']
+      end
+
+      if attributes.key?(:'print_area_width')
+        self.print_area_width = attributes[:'print_area_width']
+      end
+
+      if attributes.key?(:'print_area_height')
+        self.print_area_height = attributes[:'print_area_height']
+      end
+
+      if attributes.key?(:'print_area_top')
+        self.print_area_top = attributes[:'print_area_top']
+      end
+
+      if attributes.key?(:'print_area_left')
+        self.print_area_left = attributes[:'print_area_left']
+      end
+
+      if attributes.key?(:'is_template_on_front')
+        self.is_template_on_front = attributes[:'is_template_on_front']
+      end
+
+      if attributes.key?(:'orientation')
+        self.orientation = attributes[:'orientation']
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      orientation_validator = EnumAttributeValidator.new('String', ["horizontal", "vertical", "any"])
+      return false unless orientation_validator.valid?(@orientation)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] orientation Object to be assigned
+    def orientation=(orientation)
+      validator = EnumAttributeValidator.new('String', ["horizontal", "vertical", "any"])
+      unless validator.valid?(orientation)
+        fail ArgumentError, "invalid value for \"orientation\", must be one of #{validator.allowable_values}."
+      end
+      @orientation = orientation
+    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 &&
+          template_id == o.template_id &&
+          image_url == o.image_url &&
+          background_url == o.background_url &&
+          background_color == o.background_color &&
+          printfile_id == o.printfile_id &&
+          template_width == o.template_width &&
+          template_height == o.template_height &&
+          print_area_width == o.print_area_width &&
+          print_area_height == o.print_area_height &&
+          print_area_top == o.print_area_top &&
+          print_area_left == o.print_area_left &&
+          is_template_on_front == o.is_template_on_front &&
+          orientation == o.orientation
+    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
+      [template_id, image_url, background_url, background_color, printfile_id, template_width, template_height, print_area_width, print_area_height, print_area_top, print_area_left, is_template_on_front, orientation].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)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._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 = Printful.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