aspera-cli 4.26.1 → 4.27.0

data/lib/aspera/rest_list.rb

@@ -15,7 +15,7 @@ module Aspera
     # @param value [String] Value of field of searched entity
     # @param field [String] Field of searched entity
     # @param query [Hash] Optional additional search query parameters
-    # @returns [Hash] A single entity matching the search, or an exception if not found or multiple found
+    # @return [Hash] A single entity matching the search, or an exception if not found or multiple found
     def lookup_with_q(entity, value:, field: 'name', query: {})
       Aspera.assert_type(query, Hash){'query'}
       Aspera.assert_type(field, String){'field'}
@@ -35,8 +35,8 @@ module Aspera
         value_matches = matching_items.select{ |i| i[field].casecmp?(value)}
         case value_matches.length
         when 1 then return value_matches.first
-        when 0 then raise %Q(#{entity}: Multiple case insensitive partial match for: "#{value}" in #{matching_items.map{ |i| i[field]}.join(', ')} but no case insensitive full match. Please be more specific or give exact #{field}.)
-        else raise "Two entities cannot have the same case insensitive #{field}: #{value_matches.map{ |i| i[field]}}"
+        when 0 then raise Error, "#{entity}: Multiple case insensitive partial match for: \"#{value}\" in #{matching_items.map{ |i| i[field]}.join(', ')} but no case insensitive full match. Please be more specific or give exact #{field}."
+        else raise Error, "Two entities cannot have the same case insensitive #{field}: #{value_matches.map{ |i| i[field]}}"
         end
       end
     end
@@ -50,6 +50,7 @@ module Aspera
     # @return [Array<(Array<Hash>, Integer)>] items, total_count
     def list_entities_limit_offset_total_count(
       entity:,
+      operation: 'GET',
       items_key: nil,
       query: nil
     )
@@ -67,9 +68,15 @@ module Aspera
       # Merge default parameters, by default 100 per page
       query = {'limit'=> PER_PAGE_DEFAULT}.merge(query)
       total_count = nil
+      call_args = {
+        operation: operation,
+        subpath:   entity,
+        query:     query,
+        headers:   {'Accept' => Mime::JSON}
+      }
       loop do
         query['offset'] = offset
-        page_result = read(entity, query)
+        page_result = call(**call_args)
         Aspera.assert_type(page_result[items_key], Array)
         result.concat(page_result[items_key])
         # Reach the limit set by user ?
@@ -97,7 +104,7 @@ module Aspera
     # @param query     [Hash]   Additional query parameters (Default: `:default`)
     def lookup_entity_by_field(entity:, value:, field: 'name', items_key: nil, query: :default)
       if query.eql?(:default)
-        Aspera.assert(field.eql?('name')){'Default query is on name only'}
+        Aspera.assert_values(field, ['name']){'Default query field'}
         query = {'q'=> value}
       end
       lookup_entity_generic(entity: entity, field: field, value: value){list_entities_limit_offset_total_count(entity: entity, items_key: items_key, query: query).first}
@@ -113,7 +120,7 @@ module Aspera
     # @return [Hash] The unique matching object.
     # @raise  [Cli::BadIdentifier] If 0 or >1 matches are found.
     def lookup_entity_generic(entity:, value:, field: 'name')
-      Aspera.assert(block_given?)
+      Aspera.assert(block_given?, 'block required for lookup_entity_generic')
       found = yield
       Aspera.assert_array_all(found, Hash)
       found = found.select{ |i| i[field].eql?(value)}

data/lib/aspera/schema/IBM Aspera Faspex API-5.0-enhanced.yaml

@@ -1,3 +1,8 @@
+# DO NOT EDIT THIS FILE MANUALLY
+# This file is automatically downloaded from:
+# https://raw.githubusercontent.com/laurent-martin/aspera-api-examples/refs/heads/main/openapi/IBM%20Aspera%20Faspex%20API-5.0-enhanced.yaml
+# Use 'rake tools:openapi' to update this file
+
 openapi: 3.1.0
 info:
   title: IBM Aspera Faspex API
@@ -32646,7 +32651,12 @@ components:
                       maxLength: 255
                       minLength: 1
               expiration_policy:
-                description: The expiration policy for the package. Default is "none" for no expiration policy (a package will not be marked for deletion based on recipient downloads), "delete_after_all_download" for deleting a package after ALL users do a full download of the package (download of all files/folders in the package), "delete_after_any_download" for deleting a package after ANY user fully downloads and "delete_after_expiration_date" for deleting a package after the date set in expiration_date parameter.
+                description: |-
+                  The expiration policy for the package.
+                  * `none`: Default, for no expiration policy (a package will not be marked for deletion based on recipient downloads).
+                  * `delete_after_all_download` for deleting a package after ALL users do a full download of the package (download of all files/folders in the package).
+                  * `delete_after_any_download` for deleting a package after ANY user fully downloads.
+                  * `delete_after_expiration_date` for deleting a package after the date set in expiration_date parameter.
                 type: string
                 default: none
                 enum:
@@ -40721,9 +40731,9 @@ components:
           type: boolean
         can_have_public_url:
           description: |-
-            Specifies whether the user can share public submission submission links.\
-                                                        A user can share public submission links to invite external users to \
-                                                        send packages to the user.
+            Specifies whether the user can share public submission submission links.
+            A user can share public submission links to invite external users to
+            send packages to the user.
           type: string
           default: default
           enum: