imgwire 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df6fe59538abf5207310fee7e35a2bc69122f3e989c79bad3a674979553ddc62
-  data.tar.gz: ea52a41f725f7d9ddd339151eb1e350a815b39276caddb1db643ba8627da9a50
+  metadata.gz: cd3ca88b1ea564edd82e1ab17f6c2f3f8f416e0abcda94bdb0487c32037798ba
+  data.tar.gz: d0445e8d5bfa097bd244738ab709c810dbea33e027aee1097a5657566a618f17
 SHA512:
-  metadata.gz: fd1bfa952e82bf07d9f0c3dd517d17e6863e15a1a8107ab743c262f64a72f71a866599f2a7f79d5ff9e8c5c2ad7dcd217319732429b4e93f5c7ec0665a31d442
-  data.tar.gz: 813abc30206d27d06d109af62d0a82b6bd8068244d050a6bdfe8fbb1a4317e84012aa429c63c2d23fb8d6fecd8311469ebe2a34c92cda7229d87716fef9f3eae
+  metadata.gz: 60028a30e19f7a121a71e807e3a2702605da1d018a535fdb924c621870213cb2330df805233f1f1a11cabbb44e5dea7fa09385390eb9c3573a33b6eacf314cd2
+  data.tar.gz: d383ab6be490ef82fe783ea25667724fef42c15d47f0fa904766f70916f86867cbcd675673da49ad37f477eb192a6e599d94af2918f7934e4b8df1e9a4ea630b

data/CODEGEN_VERSION

@@ -1 +1 @@
-b57e439d6e9c3859c7bddb889658b5ff808503ccc136ea28a56e0fd57a1678aa
+57998c6d1fd50ddee463591b6b88ee751b6cc37b79ab4ce6e38af84d28cfddc3

data/README.md

@@ -89,6 +89,17 @@ image = client.images.upload(
 )
 ```
 
+To upload from a publicly reachable source URL without streaming bytes through
+your Ruby process:
+
+```ruby
+image = client.images.upload_via_url(
+  url: "https://example.com/file.jpg",
+  file_name: "file.jpg",
+  mime_type: "image/jpeg"
+)
+```
+
 ### Pagination
 
 ```ruby

data/generated/lib/imgwire-generated/api/images_api.rb

@@ -530,5 +530,71 @@ module ImgwireGenerated
       end
       return data, status_code, headers
     end
+
+    # Upload Image Via URL
+    # @param upload_via_url_create_schema [UploadViaUrlCreateSchema] 
+    # @param [Hash] opts the optional parameters
+    # @return [ImageSchema]
+    def images_upload_via_url(upload_via_url_create_schema, opts = {})
+      data, _status_code, _headers = images_upload_via_url_with_http_info(upload_via_url_create_schema, opts)
+      data
+    end
+
+    # Upload Image Via URL
+    # @param upload_via_url_create_schema [UploadViaUrlCreateSchema] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ImageSchema, Integer, Hash)>] ImageSchema data, response status code and response headers
+    def images_upload_via_url_with_http_info(upload_via_url_create_schema, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ImagesApi.images_upload_via_url ...'
+      end
+      # verify the required parameter 'upload_via_url_create_schema' is set
+      if @api_client.config.client_side_validation && upload_via_url_create_schema.nil?
+        fail ArgumentError, "Missing the required parameter 'upload_via_url_create_schema' when calling ImagesApi.images_upload_via_url"
+      end
+      # resource path
+      local_var_path = '/api/v1/images/upload_via_url'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(upload_via_url_create_schema)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ImageSchema'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"ImagesApi.images_upload_via_url",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ImagesApi#images_upload_via_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

data/generated/lib/imgwire-generated/models/upload_via_url_create_schema.rb

@@ -0,0 +1,381 @@
+=begin
+#imgwire.dev Backend API development
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.14.0
+
+=end
+
+require 'date'
+require 'time'
+
+module ImgwireGenerated
+  class UploadViaUrlCreateSchema
+    attr_accessor :custom_metadata
+
+    attr_accessor :file_name
+
+    attr_accessor :idempotency_key
+
+    attr_accessor :mime_type
+
+    attr_accessor :purpose
+
+    attr_accessor :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
+      {
+        :'custom_metadata' => :'custom_metadata',
+        :'file_name' => :'file_name',
+        :'idempotency_key' => :'idempotency_key',
+        :'mime_type' => :'mime_type',
+        :'purpose' => :'purpose',
+        :'url' => :'url'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'custom_metadata' => :'Hash<String, CustomMetadataValue>',
+        :'file_name' => :'String',
+        :'idempotency_key' => :'String',
+        :'mime_type' => :'SupportedMimeType',
+        :'purpose' => :'String',
+        :'url' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'file_name',
+        :'idempotency_key',
+        :'purpose',
+      ])
+    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 `ImgwireGenerated::UploadViaUrlCreateSchema` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `ImgwireGenerated::UploadViaUrlCreateSchema`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'custom_metadata')
+        if (value = attributes[:'custom_metadata']).is_a?(Hash)
+          self.custom_metadata = value
+        end
+      end
+
+      if attributes.key?(:'file_name')
+        self.file_name = attributes[:'file_name']
+      end
+
+      if attributes.key?(:'idempotency_key')
+        self.idempotency_key = attributes[:'idempotency_key']
+      end
+
+      if attributes.key?(:'mime_type')
+        self.mime_type = attributes[:'mime_type']
+      end
+
+      if attributes.key?(:'purpose')
+        self.purpose = attributes[:'purpose']
+      end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      else
+        self.url = nil
+      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
+      if !@file_name.nil? && @file_name.to_s.length < 1
+        invalid_properties.push('invalid value for "file_name", the character length must be greater than or equal to 1.')
+      end
+
+      if !@idempotency_key.nil? && @idempotency_key.to_s.length > 255
+        invalid_properties.push('invalid value for "idempotency_key", the character length must be smaller than or equal to 255.')
+      end
+
+      if !@idempotency_key.nil? && @idempotency_key.to_s.length < 1
+        invalid_properties.push('invalid value for "idempotency_key", the character length must be greater than or equal to 1.')
+      end
+
+      if !@purpose.nil? && @purpose.to_s.length > 255
+        invalid_properties.push('invalid value for "purpose", the character length must be smaller than or equal to 255.')
+      end
+
+      if !@purpose.nil? && @purpose.to_s.length < 1
+        invalid_properties.push('invalid value for "purpose", the character length must be greater than or equal to 1.')
+      end
+
+      if @url.nil?
+        invalid_properties.push('invalid value for "url", url cannot be nil.')
+      end
+
+      if @url.to_s.length < 1
+        invalid_properties.push('invalid value for "url", the character length must be greater than or equal to 1.')
+      end
+
+      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'
+      return false if !@file_name.nil? && @file_name.to_s.length < 1
+      return false if !@idempotency_key.nil? && @idempotency_key.to_s.length > 255
+      return false if !@idempotency_key.nil? && @idempotency_key.to_s.length < 1
+      return false if !@purpose.nil? && @purpose.to_s.length > 255
+      return false if !@purpose.nil? && @purpose.to_s.length < 1
+      return false if @url.nil?
+      return false if @url.to_s.length < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] file_name Value to be assigned
+    def file_name=(file_name)
+      if !file_name.nil? && file_name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "file_name", the character length must be greater than or equal to 1.'
+      end
+
+      @file_name = file_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] idempotency_key Value to be assigned
+    def idempotency_key=(idempotency_key)
+      if !idempotency_key.nil? && idempotency_key.to_s.length > 255
+        fail ArgumentError, 'invalid value for "idempotency_key", the character length must be smaller than or equal to 255.'
+      end
+
+      if !idempotency_key.nil? && idempotency_key.to_s.length < 1
+        fail ArgumentError, 'invalid value for "idempotency_key", the character length must be greater than or equal to 1.'
+      end
+
+      @idempotency_key = idempotency_key
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] purpose Value to be assigned
+    def purpose=(purpose)
+      if !purpose.nil? && purpose.to_s.length > 255
+        fail ArgumentError, 'invalid value for "purpose", the character length must be smaller than or equal to 255.'
+      end
+
+      if !purpose.nil? && purpose.to_s.length < 1
+        fail ArgumentError, 'invalid value for "purpose", the character length must be greater than or equal to 1.'
+      end
+
+      @purpose = purpose
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] url Value to be assigned
+    def url=(url)
+      if url.nil?
+        fail ArgumentError, 'url cannot be nil'
+      end
+
+      if url.to_s.length < 1
+        fail ArgumentError, 'invalid value for "url", the character length must be greater than or equal to 1.'
+      end
+
+      @url = url
+    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 &&
+          custom_metadata == o.custom_metadata &&
+          file_name == o.file_name &&
+          idempotency_key == o.idempotency_key &&
+          mime_type == o.mime_type &&
+          purpose == o.purpose &&
+          url == o.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
+      [custom_metadata, file_name, idempotency_key, mime_type, purpose, 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)
+      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 = ImgwireGenerated.const_get(type)
+        klass.respond_to?(:openapi_any_of) || 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/generated/lib/imgwire-generated.rb

@@ -46,6 +46,7 @@ require 'imgwire-generated/models/supported_mime_type'
 require 'imgwire-generated/models/transfer_bytes_dataset_point_schema'
 require 'imgwire-generated/models/transformations_dataset_point_schema'
 require 'imgwire-generated/models/upload_token_create_response_schema'
+require 'imgwire-generated/models/upload_via_url_create_schema'
 require 'imgwire-generated/models/uploads_dataset_point_schema'
 require 'imgwire-generated/models/validation_error'
 

data/lib/imgwire/resources/images_resource.rb

@@ -62,6 +62,31 @@ module Imgwire
         @api.images_retrieve_bulk_download_job(image_download_job_id)
       end
 
+      def upload_via_url(
+        url:,
+        file_name: nil,
+        mime_type: nil,
+        custom_metadata: nil,
+        idempotency_key: nil,
+        purpose: nil
+      )
+        Image.wrap(
+          @api.images_upload_via_url(
+            coerce_model(
+              ImgwireGenerated::UploadViaUrlCreateSchema,
+              {
+                custom_metadata: custom_metadata,
+                file_name: file_name,
+                idempotency_key: idempotency_key,
+                mime_type: mime_type,
+                purpose: purpose,
+                url: url
+              }
+            )
+          )
+        )
+      end
+
       def upload(
         file:,
         file_name: nil,

data/lib/imgwire/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Imgwire
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imgwire
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Blackhawk Software, LLC
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-04-30 00:00:00.000000000 Z
+date: 2026-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -129,6 +129,7 @@ files:
 - generated/lib/imgwire-generated/models/transfer_bytes_dataset_point_schema.rb
 - generated/lib/imgwire-generated/models/transformations_dataset_point_schema.rb
 - generated/lib/imgwire-generated/models/upload_token_create_response_schema.rb
+- generated/lib/imgwire-generated/models/upload_via_url_create_schema.rb
 - generated/lib/imgwire-generated/models/uploads_dataset_point_schema.rb
 - generated/lib/imgwire-generated/models/validation_error.rb
 - generated/lib/imgwire-generated/version.rb