mirror of
https://github.com/stripe/stripe-ruby.git
synced 2025-10-06 00:02:18 -04:00
41f5d0a594
* Support for APIs in the new API version 2024-09-30.acacia (#1458) * remove parseSnapshotEvent (#1463) * Bump version to 13.0.0 * Fixed API Version --------- Co-authored-by: Ramya Rao <100975018+ramya-stripe@users.noreply.github.com> Co-authored-by: Ramya Rao <ramya@stripe.com> Co-authored-by: Prathmesh Ranaut <prathmesh@stripe.com>
59 lines
2.2 KiB
Ruby
59 lines
2.2 KiB
Ruby
# File generated from our OpenAPI spec
|
|
# frozen_string_literal: true
|
|
|
|
module Stripe
|
|
# This object represents files hosted on Stripe's servers. You can upload
|
|
# files with the [create file](https://stripe.com/docs/api#create_file) request
|
|
# (for example, when uploading dispute evidence). Stripe also
|
|
# creates files independently (for example, the results of a [Sigma scheduled
|
|
# query](https://stripe.com/docs/api#scheduled_queries)).
|
|
#
|
|
# Related guide: [File upload guide](https://stripe.com/docs/file-upload)
|
|
class File < APIResource
|
|
extend Stripe::APIOperations::Create
|
|
extend Stripe::APIOperations::List
|
|
|
|
OBJECT_NAME = "file"
|
|
def self.object_name
|
|
"file"
|
|
end
|
|
|
|
# To upload a file to Stripe, you need to send a request of type multipart/form-data. Include the file you want to upload in the request, and the parameters for creating a file.
|
|
#
|
|
# All of Stripe's officially supported Client libraries support sending multipart/form-data.
|
|
def self.create(params = {}, opts = {})
|
|
if params[:file] && !params[:file].is_a?(String) && !params[:file].respond_to?(:read)
|
|
raise ArgumentError, "file must respond to `#read`"
|
|
end
|
|
|
|
opts = { content_type: MultipartEncoder::MULTIPART_FORM_DATA }.merge(Util.normalize_opts(opts))
|
|
|
|
request_stripe_object(
|
|
method: :post,
|
|
path: "/v1/files",
|
|
params: params,
|
|
opts: opts,
|
|
base_address: :files
|
|
)
|
|
end
|
|
|
|
# Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.
|
|
def self.list(filters = {}, opts = {})
|
|
request_stripe_object(method: :get, path: "/v1/files", params: filters, opts: opts)
|
|
end
|
|
|
|
# This resource can have two different object names. In latter API
|
|
# versions, only `file` is used, but since stripe-ruby may be used with
|
|
# any API version, we need to support deserializing the older
|
|
# `file_upload` object into the same class.
|
|
OBJECT_NAME_ALT = "file_upload"
|
|
def self.object_name_alt
|
|
"file_upload"
|
|
end
|
|
|
|
def self.resource_url
|
|
"/v1/files"
|
|
end
|
|
end
|
|
end
|