Class: Imgwire::Resources::ImagesResource
- Inherits:
-
BaseResource
- Object
- BaseResource
- Imgwire::Resources::ImagesResource
- Defined in:
- lib/imgwire/resources/images_resource.rb
Instance Method Summary collapse
- #bulk_delete(payload) ⇒ Object
- #create(payload, upload_token: nil) ⇒ Object
- #create_bulk_download_job(payload) ⇒ Object
- #create_upload_token ⇒ Object
- #delete(image_id) ⇒ Object
-
#initialize(api_client, options) ⇒ ImagesResource
constructor
A new instance of ImagesResource.
- #list(page: nil, limit: nil) ⇒ Object
- #list_all(page: 1, limit: nil) ⇒ Object
- #list_pages(page: 1, limit: nil) ⇒ Object
- #retrieve(image_id) ⇒ Object
- #retrieve_bulk_download_job(image_download_job_id) ⇒ Object
- #upload(file:, file_name: nil, mime_type: nil, content_length: nil, custom_metadata: nil, hash_sha256: nil, idempotency_key: nil, purpose: nil) ⇒ Object
Constructor Details
#initialize(api_client, options) ⇒ ImagesResource
Returns a new instance of ImagesResource.
6 7 8 9 10 |
# File 'lib/imgwire/resources/images_resource.rb', line 6 def initialize(api_client, ) super(api_client) @api = ImgwireGenerated::ImagesApi.new(api_client) @options = end |
Instance Method Details
#bulk_delete(payload) ⇒ Object
12 13 14 15 16 |
# File 'lib/imgwire/resources/images_resource.rb', line 12 def bulk_delete(payload) @api.images_bulk_delete( coerce_model(ImgwireGenerated::BulkDeleteImagesSchema, payload) ) end |
#create(payload, upload_token: nil) ⇒ Object
18 19 20 21 22 23 24 25 |
# File 'lib/imgwire/resources/images_resource.rb', line 18 def create(payload, upload_token: nil) response = @api.images_create( coerce_model(ImgwireGenerated::StandardUploadCreateSchema, payload), upload_token: upload_token ) response.image = Image.wrap(response.image) response end |
#create_bulk_download_job(payload) ⇒ Object
27 28 29 30 31 |
# File 'lib/imgwire/resources/images_resource.rb', line 27 def create_bulk_download_job(payload) @api.images_create_bulk_download_job( coerce_model(ImgwireGenerated::ImageDownloadJobCreateSchema, payload) ) end |
#create_upload_token ⇒ Object
33 34 35 |
# File 'lib/imgwire/resources/images_resource.rb', line 33 def create_upload_token @api.images_create_upload_token end |
#delete(image_id) ⇒ Object
37 38 39 |
# File 'lib/imgwire/resources/images_resource.rb', line 37 def delete(image_id) @api.images_delete(image_id) end |
#list(page: nil, limit: nil) ⇒ Object
41 42 43 44 45 |
# File 'lib/imgwire/resources/images_resource.rb', line 41 def list(page: nil, limit: nil) page_result = to_page(@api.images_list_with_http_info(page: page, limit: limit)) page_result.data = page_result.data.map { |image| Image.wrap(image) } page_result end |
#list_all(page: 1, limit: nil) ⇒ Object
53 54 55 |
# File 'lib/imgwire/resources/images_resource.rb', line 53 def list_all(page: 1, limit: nil) Pagination::ItemEnumerator.new(list_pages(page: page, limit: limit)) end |
#list_pages(page: 1, limit: nil) ⇒ Object
47 48 49 50 51 |
# File 'lib/imgwire/resources/images_resource.rb', line 47 def list_pages(page: 1, limit: nil) Pagination::PageEnumerator.new(page: page, limit: limit) do |current_page, current_limit| list(page: current_page, limit: current_limit) end end |
#retrieve(image_id) ⇒ Object
57 58 59 |
# File 'lib/imgwire/resources/images_resource.rb', line 57 def retrieve(image_id) Image.wrap(@api.images_retrieve(image_id)) end |
#retrieve_bulk_download_job(image_download_job_id) ⇒ Object
61 62 63 |
# File 'lib/imgwire/resources/images_resource.rb', line 61 def retrieve_bulk_download_job(image_download_job_id) @api.images_retrieve_bulk_download_job(image_download_job_id) end |
#upload(file:, file_name: nil, mime_type: nil, content_length: nil, custom_metadata: nil, hash_sha256: nil, idempotency_key: nil, purpose: nil) ⇒ Object
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
# File 'lib/imgwire/resources/images_resource.rb', line 65 def upload( file:, file_name: nil, mime_type: nil, content_length: nil, custom_metadata: nil, hash_sha256: nil, idempotency_key: nil, purpose: nil ) resolved = Uploads.resolve( file: file, file_name: file_name, mime_type: mime_type, content_length: content_length ) created = create( { content_length: resolved.content_length, custom_metadata: , file_name: resolved.file_name, hash_sha256: hash_sha256, idempotency_key: idempotency_key, mime_type: resolved.mime_type, purpose: purpose } ) @options.upload_http_client.put( created.upload_url, resolved, timeout: @options.timeout, max_retries: @options.max_retries, backoff_factor: @options.backoff_factor ) created.image end |