pulp_python_client 3.32.1 → 3.33.0

data/lib/pulp_python_client/models/yank.rb

@@ -0,0 +1,290 @@
+=begin
+#Pulp 3 API
+
+#Fetch, Upload, Organize, and Distribute Software Packages
+
+The version of the OpenAPI document: v3
+Contact: pulp-list@redhat.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'date'
+require 'time'
+
+module PulpPythonClient
+  # A Serializer for yank/unyank requests (PEP 592).
+  class Yank
+    # The name of the package to yank or unyank.
+    attr_accessor :name
+
+    # The version of the package to yank or unyank.
+    attr_accessor :version
+
+    # The reason for yanking the package version.
+    attr_accessor :yanked_reason
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'version' => :'version',
+        :'yanked_reason' => :'yanked_reason'
+      }
+    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
+      {
+        :'name' => :'String',
+        :'version' => :'String',
+        :'yanked_reason' => :'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 `PulpPythonClient::Yank` 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 `PulpPythonClient::Yank`. 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?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'version')
+        self.version = attributes[:'version']
+      else
+        self.version = nil
+      end
+
+      if attributes.key?(:'yanked_reason')
+        self.yanked_reason = attributes[:'yanked_reason']
+      else
+        self.yanked_reason = ''
+      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 @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @name.to_s.length < 1
+        invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
+      end
+
+      if @version.nil?
+        invalid_properties.push('invalid value for "version", version cannot be nil.')
+      end
+
+      if @version.to_s.length < 1
+        invalid_properties.push('invalid value for "version", the character length must be great 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 @name.nil?
+      return false if @name.to_s.length < 1
+      return false if @version.nil?
+      return false if @version.to_s.length < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      if name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 1.'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] version Value to be assigned
+    def version=(version)
+      if version.nil?
+        fail ArgumentError, 'version cannot be nil'
+      end
+
+      if version.to_s.length < 1
+        fail ArgumentError, 'invalid value for "version", the character length must be great than or equal to 1.'
+      end
+
+      @version = version
+    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 &&
+          name == o.name &&
+          version == o.version &&
+          yanked_reason == o.yanked_reason
+    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
+      [name, version, yanked_reason].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 = PulpPythonClient.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/lib/pulp_python_client/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.10.0
 =end
 
 module PulpPythonClient
-  VERSION = '3.32.1'
+  VERSION = '3.33.0'
 end

data/lib/pulp_python_client.rb

@@ -31,6 +31,7 @@ require 'pulp_python_client/models/package_types_enum'
 require 'pulp_python_client/models/package_upload_task_response'
 require 'pulp_python_client/models/paginated_repository_version_response_list'
 require 'pulp_python_client/models/paginatedpython_package_provenance_response_list'
+require 'pulp_python_client/models/paginatedpython_package_yank_response_list'
 require 'pulp_python_client/models/paginatedpython_python_blocklist_entry_response_list'
 require 'pulp_python_client/models/paginatedpython_python_distribution_response_list'
 require 'pulp_python_client/models/paginatedpython_python_package_content_response_list'
@@ -43,6 +44,7 @@ require 'pulp_python_client/models/patchedpython_python_repository'
 require 'pulp_python_client/models/policy_enum'
 require 'pulp_python_client/models/protocol_version_enum'
 require 'pulp_python_client/models/python_package_provenance_response'
+require 'pulp_python_client/models/python_package_yank_response'
 require 'pulp_python_client/models/python_python_blocklist_entry'
 require 'pulp_python_client/models/python_python_blocklist_entry_response'
 require 'pulp_python_client/models/python_python_distribution'
@@ -66,10 +68,12 @@ require 'pulp_python_client/models/set_label_response'
 require 'pulp_python_client/models/summary_response'
 require 'pulp_python_client/models/unset_label'
 require 'pulp_python_client/models/unset_label_response'
+require 'pulp_python_client/models/yank'
 
 # APIs
 require 'pulp_python_client/api/content_packages_api'
 require 'pulp_python_client/api/content_provenance_api'
+require 'pulp_python_client/api/content_yanks_api'
 require 'pulp_python_client/api/distributions_pypi_api'
 require 'pulp_python_client/api/publications_pypi_api'
 require 'pulp_python_client/api/pypi_api'
@@ -77,6 +81,8 @@ require 'pulp_python_client/api/pypi_legacy_api'
 require 'pulp_python_client/api/pypi_metadata_api'
 require 'pulp_python_client/api/pypi_provenance_api'
 require 'pulp_python_client/api/pypi_simple_api'
+require 'pulp_python_client/api/pypi_unyank_api'
+require 'pulp_python_client/api/pypi_yank_api'
 require 'pulp_python_client/api/remotes_python_api'
 require 'pulp_python_client/api/repositories_python_api'
 require 'pulp_python_client/api/repositories_python_blocklist_entries_api'

data/spec/api/content_packages_api_spec.rb

@@ -121,6 +121,7 @@ describe 'ContentPackagesApi' do
   # @option opts [String] :version__gte Filter results where version is greater than or equal to value
   # @option opts [String] :version__lt Filter results where version is less than value
   # @option opts [String] :version__lte Filter results where version is less than or equal to value
+  # @option opts [String] :version_specifier Filter by PEP 440 version specifier (e.g., >=2.4,<3.0 or ~=1.26)
   # @option opts [Array<String>] :fields A list of fields to include in the response.
   # @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response.
   # @return [PaginatedpythonPythonPackageContentResponseList]

data/spec/api/content_yanks_api_spec.rb

@@ -0,0 +1,104 @@
+=begin
+#Pulp 3 API
+
+#Fetch, Upload, Organize, and Distribute Software Packages
+
+The version of the OpenAPI document: v3
+Contact: pulp-list@redhat.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for PulpPythonClient::ContentYanksApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'ContentYanksApi' do
+  before do
+    # run before each test
+    @api_instance = PulpPythonClient::ContentYanksApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ContentYanksApi' do
+    it 'should create an instance of ContentYanksApi' do
+      expect(@api_instance).to be_instance_of(PulpPythonClient::ContentYanksApi)
+    end
+  end
+
+  # unit tests for list
+  # List package yanks
+  # Read-only viewset for PackageYank content units (PEP 592). PackageYank markers indicate that a package version has been yanked in a repository. Use the /yank/ and /unyank/ PyPI endpoints to create or remove these markers.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<String>] :x_task_diagnostics List of profilers to use on tasks.
+  # @option opts [Integer] :limit Number of results to return per page.
+  # @option opts [Integer] :offset The initial index from which to return the results.
+  # @option opts [Array<String>] :ordering Ordering  * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending)
+  # @option opts [Float] :orphaned_for Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.
+  # @option opts [Array<String>] :prn__in Multiple values may be separated by commas.
+  # @option opts [Array<String>] :pulp_href__in Multiple values may be separated by commas.
+  # @option opts [Array<String>] :pulp_id__in Multiple values may be separated by commas.
+  # @option opts [String] :pulp_label_select Filter labels by search string
+  # @option opts [String] :q Filter results by using NOT, AND and OR operations on other filters
+  # @option opts [String] :repository_version 
+  # @option opts [String] :repository_version_added 
+  # @option opts [String] :repository_version_removed 
+  # @option opts [Array<String>] :fields A list of fields to include in the response.
+  # @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response.
+  # @return [PaginatedpythonPackageYankResponseList]
+  describe 'list test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for read
+  # Inspect a package yank
+  # Read-only viewset for PackageYank content units (PEP 592). PackageYank markers indicate that a package version has been yanked in a repository. Use the /yank/ and /unyank/ PyPI endpoints to create or remove these markers.
+  # @param python_package_yank_href 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<String>] :x_task_diagnostics List of profilers to use on tasks.
+  # @option opts [Array<String>] :fields A list of fields to include in the response.
+  # @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response.
+  # @return [PythonPackageYankResponse]
+  describe 'read test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for set_label
+  # Set a label
+  # Set a single pulp_label on the object to a specific value or null.
+  # @param python_package_yank_href 
+  # @param set_label 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<String>] :x_task_diagnostics List of profilers to use on tasks.
+  # @return [SetLabelResponse]
+  describe 'set_label test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for unset_label
+  # Unset a label
+  # Unset a single pulp_label on the object.
+  # @param python_package_yank_href 
+  # @param unset_label 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<String>] :x_task_diagnostics List of profilers to use on tasks.
+  # @return [UnsetLabelResponse]
+  describe 'unset_label test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/pypi_legacy_api_spec.rb

@@ -43,7 +43,7 @@ describe 'PypiLegacyApi' do
   # @option opts [String] :action Defaults to `file_upload`, don't change it or request will fail!
   # @option opts [ProtocolVersionEnum] :protocol_version Protocol version to use for the upload. Only version 1 is supported.  * `1` - 1
   # @option opts [FiletypeEnum] :filetype Type of artifact to upload.  * `bdist_wheel` - bdist_wheel * `sdist` - sdist
-  # @option opts [MetadataVersionEnum] :metadata_version Metadata version of the uploaded package.  * `1.0` - 1.0 * `1.1` - 1.1 * `1.2` - 1.2 * `2.0` - 2.0 * `2.1` - 2.1 * `2.2` - 2.2 * `2.3` - 2.3 * `2.4` - 2.4
+  # @option opts [MetadataVersionEnum] :metadata_version Metadata version of the uploaded package.  * `1.0` - 1.0 * `1.1` - 1.1 * `1.2` - 1.2 * `2.0` - 2.0 * `2.1` - 2.1 * `2.2` - 2.2 * `2.3` - 2.3 * `2.4` - 2.4 * `2.5` - 2.5
   # @option opts [Object] :attestations 
   # @return [PackageUploadTaskResponse]
   describe 'create test' do

data/spec/api/pypi_simple_api_spec.rb

@@ -43,7 +43,7 @@ describe 'PypiSimpleApi' do
   # @option opts [String] :action Defaults to `file_upload`, don't change it or request will fail!
   # @option opts [ProtocolVersionEnum] :protocol_version Protocol version to use for the upload. Only version 1 is supported.  * `1` - 1
   # @option opts [FiletypeEnum] :filetype Type of artifact to upload.  * `bdist_wheel` - bdist_wheel * `sdist` - sdist
-  # @option opts [MetadataVersionEnum] :metadata_version Metadata version of the uploaded package.  * `1.0` - 1.0 * `1.1` - 1.1 * `1.2` - 1.2 * `2.0` - 2.0 * `2.1` - 2.1 * `2.2` - 2.2 * `2.3` - 2.3 * `2.4` - 2.4
+  # @option opts [MetadataVersionEnum] :metadata_version Metadata version of the uploaded package.  * `1.0` - 1.0 * `1.1` - 1.1 * `1.2` - 1.2 * `2.0` - 2.0 * `2.1` - 2.1 * `2.2` - 2.2 * `2.3` - 2.3 * `2.4` - 2.4 * `2.5` - 2.5
   # @option opts [Object] :attestations 
   # @return [PackageUploadTaskResponse]
   describe 'create test' do

data/spec/api/pypi_unyank_api_spec.rb

@@ -0,0 +1,49 @@
+=begin
+#Pulp 3 API
+
+#Fetch, Upload, Organize, and Distribute Software Packages
+
+The version of the OpenAPI document: v3
+Contact: pulp-list@redhat.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for PulpPythonClient::PypiUnyankApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'PypiUnyankApi' do
+  before do
+    # run before each test
+    @api_instance = PulpPythonClient::PypiUnyankApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of PypiUnyankApi' do
+    it 'should create an instance of PypiUnyankApi' do
+      expect(@api_instance).to be_instance_of(PulpPythonClient::PypiUnyankApi)
+    end
+  end
+
+  # unit tests for unyank
+  # Unyank a package version
+  # Unyank a package version, unmarking all its files with data-yanked.
+  # @param path 
+  # @param yank 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<String>] :x_task_diagnostics List of profilers to use on tasks.
+  # @return [AsyncOperationResponse]
+  describe 'unyank test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/pypi_yank_api_spec.rb

@@ -0,0 +1,49 @@
+=begin
+#Pulp 3 API
+
+#Fetch, Upload, Organize, and Distribute Software Packages
+
+The version of the OpenAPI document: v3
+Contact: pulp-list@redhat.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for PulpPythonClient::PypiYankApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'PypiYankApi' do
+  before do
+    # run before each test
+    @api_instance = PulpPythonClient::PypiYankApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of PypiYankApi' do
+    it 'should create an instance of PypiYankApi' do
+      expect(@api_instance).to be_instance_of(PulpPythonClient::PypiYankApi)
+    end
+  end
+
+  # unit tests for yank
+  # Yank a package version
+  # Yank a package version, marking all its files with data-yanked.
+  # @param path 
+  # @param yank 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<String>] :x_task_diagnostics List of profilers to use on tasks.
+  # @return [AsyncOperationResponse]
+  describe 'yank test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/models/paginatedpython_package_yank_response_list_spec.rb

@@ -0,0 +1,54 @@
+=begin
+#Pulp 3 API
+
+#Fetch, Upload, Organize, and Distribute Software Packages
+
+The version of the OpenAPI document: v3
+Contact: pulp-list@redhat.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for PulpPythonClient::PaginatedpythonPackageYankResponseList
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe PulpPythonClient::PaginatedpythonPackageYankResponseList do
+  let(:instance) { PulpPythonClient::PaginatedpythonPackageYankResponseList.new }
+
+  describe 'test an instance of PaginatedpythonPackageYankResponseList' do
+    it 'should create an instance of PaginatedpythonPackageYankResponseList' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(PulpPythonClient::PaginatedpythonPackageYankResponseList)
+    end
+  end
+
+  describe 'test attribute "count"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "_next"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "previous"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "results"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end