stripe 12.5.0 → 15.0.0

data/lib/stripe/services/entitlements/active_entitlement_service.rb

@@ -0,0 +1,66 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Entitlements
+    class ActiveEntitlementService < StripeService
+      class ListParams < Stripe::RequestParams
+        # The ID of the customer.
+        attr_accessor :customer
+        # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+        attr_accessor :ending_before
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+        attr_accessor :limit
+        # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+        attr_accessor :starting_after
+
+        def initialize(
+          customer: nil,
+          ending_before: nil,
+          expand: nil,
+          limit: nil,
+          starting_after: nil
+        )
+          @customer = customer
+          @ending_before = ending_before
+          @expand = expand
+          @limit = limit
+          @starting_after = starting_after
+        end
+      end
+
+      class RetrieveParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      # Retrieve a list of active entitlements for a customer
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/entitlements/active_entitlements",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieve an active entitlement
+      def retrieve(id, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/entitlements/active_entitlements/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/entitlements/feature_service.rb

@@ -0,0 +1,128 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Entitlements
+    class FeatureService < StripeService
+      class ListParams < Stripe::RequestParams
+        # If set, filter results to only include features with the given archive status.
+        attr_accessor :archived
+        # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+        attr_accessor :ending_before
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+        attr_accessor :limit
+        # If set, filter results to only include features with the given lookup_key.
+        attr_accessor :lookup_key
+        # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+        attr_accessor :starting_after
+
+        def initialize(
+          archived: nil,
+          ending_before: nil,
+          expand: nil,
+          limit: nil,
+          lookup_key: nil,
+          starting_after: nil
+        )
+          @archived = archived
+          @ending_before = ending_before
+          @expand = expand
+          @limit = limit
+          @lookup_key = lookup_key
+          @starting_after = starting_after
+        end
+      end
+
+      class CreateParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # A unique key you provide as your own system identifier. This may be up to 80 characters.
+        attr_accessor :lookup_key
+        # Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+        attr_accessor :metadata
+        # The feature's name, for your own purpose, not meant to be displayable to the customer.
+        attr_accessor :name
+
+        def initialize(expand: nil, lookup_key: nil, metadata: nil, name: nil)
+          @expand = expand
+          @lookup_key = lookup_key
+          @metadata = metadata
+          @name = name
+        end
+      end
+
+      class RetrieveParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      class UpdateParams < Stripe::RequestParams
+        # Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
+        attr_accessor :active
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+        attr_accessor :metadata
+        # The feature's name, for your own purpose, not meant to be displayable to the customer.
+        attr_accessor :name
+
+        def initialize(active: nil, expand: nil, metadata: nil, name: nil)
+          @active = active
+          @expand = expand
+          @metadata = metadata
+          @name = name
+        end
+      end
+
+      # Creates a feature
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/entitlements/features",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieve a list of features
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/entitlements/features",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves a feature
+      def retrieve(id, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/entitlements/features/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Update a feature's metadata or permanently deactivate it.
+      def update(id, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/entitlements/features/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/entitlements_service.rb

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class EntitlementsService < StripeService
+    attr_reader :active_entitlements, :features
+
+    def initialize(requestor)
+      super(requestor)
+      @active_entitlements = Stripe::Entitlements::ActiveEntitlementService.new(@requestor)
+      @features = Stripe::Entitlements::FeatureService.new(@requestor)
+    end
+  end
+end

data/lib/stripe/services/ephemeral_key_service.rb

@@ -0,0 +1,64 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class EphemeralKeyService < StripeService
+    class DeleteParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+
+    class CreateParams < Stripe::RequestParams
+      # The ID of the Customer you'd like to modify using the resulting ephemeral key.
+      attr_accessor :customer
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # The ID of the Issuing Card you'd like to access using the resulting ephemeral key.
+      attr_accessor :issuing_card
+      # A single-use token, created by Stripe.js, used for creating ephemeral keys for Issuing Cards without exchanging sensitive information.
+      attr_accessor :nonce
+      # The ID of the Identity VerificationSession you'd like to access using the resulting ephemeral key
+      attr_accessor :verification_session
+
+      def initialize(
+        customer: nil,
+        expand: nil,
+        issuing_card: nil,
+        nonce: nil,
+        verification_session: nil
+      )
+        @customer = customer
+        @expand = expand
+        @issuing_card = issuing_card
+        @nonce = nonce
+        @verification_session = verification_session
+      end
+    end
+
+    # Creates a short-lived API key for a given resource.
+    def create(params = {}, opts = {})
+      request(
+        method: :post,
+        path: "/v1/ephemeral_keys",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Invalidates a short-lived API key for a given resource.
+    def delete(key, params = {}, opts = {})
+      request(
+        method: :delete,
+        path: format("/v1/ephemeral_keys/%<key>s", { key: CGI.escape(key) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/event_service.rb

@@ -0,0 +1,87 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class EventService < StripeService
+    class ListParams < Stripe::RequestParams
+      class Created < Stripe::RequestParams
+        # Minimum value to filter by (exclusive)
+        attr_accessor :gt
+        # Minimum value to filter by (inclusive)
+        attr_accessor :gte
+        # Maximum value to filter by (exclusive)
+        attr_accessor :lt
+        # Maximum value to filter by (inclusive)
+        attr_accessor :lte
+
+        def initialize(gt: nil, gte: nil, lt: nil, lte: nil)
+          @gt = gt
+          @gte = gte
+          @lt = lt
+          @lte = lte
+        end
+      end
+      # Only return events that were created during the given date interval.
+      attr_accessor :created
+      # Filter events by whether all webhooks were successfully delivered. If false, events which are still pending or have failed all delivery attempts to a webhook endpoint will be returned.
+      attr_accessor :delivery_success
+      # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+      attr_accessor :ending_before
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+      attr_accessor :limit
+      # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+      attr_accessor :starting_after
+      # A string containing a specific event name, or group of events using * as a wildcard. The list will be filtered to include only events with a matching event property.
+      attr_accessor :type
+      # An array of up to 20 strings containing specific event names. The list will be filtered to include only events with a matching event property. You may pass either `type` or `types`, but not both.
+      attr_accessor :types
+
+      def initialize(
+        created: nil,
+        delivery_success: nil,
+        ending_before: nil,
+        expand: nil,
+        limit: nil,
+        starting_after: nil,
+        type: nil,
+        types: nil
+      )
+        @created = created
+        @delivery_success = delivery_success
+        @ending_before = ending_before
+        @expand = expand
+        @limit = limit
+        @starting_after = starting_after
+        @type = type
+        @types = types
+      end
+    end
+
+    class RetrieveParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+
+    # List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in [event object](https://docs.stripe.com/api/events/object) api_version attribute (not according to your current Stripe API version or Stripe-Version header).
+    def list(params = {}, opts = {})
+      request(method: :get, path: "/v1/events", params: params, opts: opts, base_address: :api)
+    end
+
+    # Retrieves the details of an event if it was created in the last 30 days. Supply the unique identifier of the event, which you might have received in a webhook.
+    def retrieve(id, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/events/%<id>s", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/exchange_rate_service.rb

@@ -0,0 +1,55 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class ExchangeRateService < StripeService
+    class ListParams < Stripe::RequestParams
+      # A cursor for use in pagination. `ending_before` is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with the exchange rate for currency X your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+      attr_accessor :ending_before
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # A limit on the number of objects to be returned. Limit can range between 1 and total number of supported payout currencies, and the default is the max.
+      attr_accessor :limit
+      # A cursor for use in pagination. `starting_after` is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with the exchange rate for currency X, your subsequent call can include `starting_after=X` in order to fetch the next page of the list.
+      attr_accessor :starting_after
+
+      def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil)
+        @ending_before = ending_before
+        @expand = expand
+        @limit = limit
+        @starting_after = starting_after
+      end
+    end
+
+    class RetrieveParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+
+    # Returns a list of objects that contain the rates at which foreign currencies are converted to one another. Only shows the currencies for which Stripe supports.
+    def list(params = {}, opts = {})
+      request(
+        method: :get,
+        path: "/v1/exchange_rates",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieves the exchange rates from the given currency to every supported currency.
+    def retrieve(rate_id, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/exchange_rates/%<rate_id>s", { rate_id: CGI.escape(rate_id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/file_link_service.rb

@@ -0,0 +1,132 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class FileLinkService < StripeService
+    class ListParams < Stripe::RequestParams
+      class Created < Stripe::RequestParams
+        # Minimum value to filter by (exclusive)
+        attr_accessor :gt
+        # Minimum value to filter by (inclusive)
+        attr_accessor :gte
+        # Maximum value to filter by (exclusive)
+        attr_accessor :lt
+        # Maximum value to filter by (inclusive)
+        attr_accessor :lte
+
+        def initialize(gt: nil, gte: nil, lt: nil, lte: nil)
+          @gt = gt
+          @gte = gte
+          @lt = lt
+          @lte = lte
+        end
+      end
+      # Only return links that were created during the given date interval.
+      attr_accessor :created
+      # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+      attr_accessor :ending_before
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # Filter links by their expiration status. By default, Stripe returns all links.
+      attr_accessor :expired
+      # Only return links for the given file.
+      attr_accessor :file
+      # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+      attr_accessor :limit
+      # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+      attr_accessor :starting_after
+
+      def initialize(
+        created: nil,
+        ending_before: nil,
+        expand: nil,
+        expired: nil,
+        file: nil,
+        limit: nil,
+        starting_after: nil
+      )
+        @created = created
+        @ending_before = ending_before
+        @expand = expand
+        @expired = expired
+        @file = file
+        @limit = limit
+        @starting_after = starting_after
+      end
+    end
+
+    class CreateParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # The link isn't usable after this future timestamp.
+      attr_accessor :expires_at
+      # The ID of the file. The file's `purpose` must be one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `financial_account_statement`, `identity_document_downloadable`, `issuing_regulatory_reporting`, `pci_document`, `selfie`, `sigma_scheduled_query`, `tax_document_user_upload`, or `terminal_reader_splashscreen`.
+      attr_accessor :file
+      # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+      attr_accessor :metadata
+
+      def initialize(expand: nil, expires_at: nil, file: nil, metadata: nil)
+        @expand = expand
+        @expires_at = expires_at
+        @file = file
+        @metadata = metadata
+      end
+    end
+
+    class RetrieveParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+
+    class UpdateParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # A future timestamp after which the link will no longer be usable, or `now` to expire the link immediately.
+      attr_accessor :expires_at
+      # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+      attr_accessor :metadata
+
+      def initialize(expand: nil, expires_at: nil, metadata: nil)
+        @expand = expand
+        @expires_at = expires_at
+        @metadata = metadata
+      end
+    end
+
+    # Creates a new file link object.
+    def create(params = {}, opts = {})
+      request(method: :post, path: "/v1/file_links", params: params, opts: opts, base_address: :api)
+    end
+
+    # Returns a list of file links.
+    def list(params = {}, opts = {})
+      request(method: :get, path: "/v1/file_links", params: params, opts: opts, base_address: :api)
+    end
+
+    # Retrieves the file link with the given ID.
+    def retrieve(link, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/file_links/%<link>s", { link: CGI.escape(link) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Updates an existing file link object. Expired links can no longer be updated.
+    def update(link, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/file_links/%<link>s", { link: CGI.escape(link) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/file_service.rb

@@ -0,0 +1,124 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class FileService < StripeService
+    class ListParams < Stripe::RequestParams
+      class Created < Stripe::RequestParams
+        # Minimum value to filter by (exclusive)
+        attr_accessor :gt
+        # Minimum value to filter by (inclusive)
+        attr_accessor :gte
+        # Maximum value to filter by (exclusive)
+        attr_accessor :lt
+        # Maximum value to filter by (inclusive)
+        attr_accessor :lte
+
+        def initialize(gt: nil, gte: nil, lt: nil, lte: nil)
+          @gt = gt
+          @gte = gte
+          @lt = lt
+          @lte = lte
+        end
+      end
+      # Only return files that were created during the given date interval.
+      attr_accessor :created
+      # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+      attr_accessor :ending_before
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+      attr_accessor :limit
+      # Filter queries by the file purpose. If you don't provide a purpose, the queries return unfiltered files.
+      attr_accessor :purpose
+      # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+      attr_accessor :starting_after
+
+      def initialize(
+        created: nil,
+        ending_before: nil,
+        expand: nil,
+        limit: nil,
+        purpose: nil,
+        starting_after: nil
+      )
+        @created = created
+        @ending_before = ending_before
+        @expand = expand
+        @limit = limit
+        @purpose = purpose
+        @starting_after = starting_after
+      end
+    end
+
+    class CreateParams < Stripe::RequestParams
+      class FileLinkData < Stripe::RequestParams
+        # Set this to `true` to create a file link for the newly created file. Creating a link is only possible when the file's `purpose` is one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `issuing_regulatory_reporting`, `pci_document`, `tax_document_user_upload`, or `terminal_reader_splashscreen`.
+        attr_accessor :create
+        # The link isn't available after this future timestamp.
+        attr_accessor :expires_at
+        # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+        attr_accessor :metadata
+
+        def initialize(create: nil, expires_at: nil, metadata: nil)
+          @create = create
+          @expires_at = expires_at
+          @metadata = metadata
+        end
+      end
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # A file to upload. Make sure that the specifications follow RFC 2388, which defines file transfers for the `multipart/form-data` protocol.
+      attr_accessor :file
+      # Optional parameters that automatically create a [file link](https://stripe.com/docs/api#file_links) for the newly created file.
+      attr_accessor :file_link_data
+      # The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file.
+      attr_accessor :purpose
+
+      def initialize(expand: nil, file: nil, file_link_data: nil, purpose: nil)
+        @expand = expand
+        @file = file
+        @file_link_data = file_link_data
+        @purpose = purpose
+      end
+    end
+
+    class RetrieveParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    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 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(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 list(params = {}, opts = {})
+      request(method: :get, path: "/v1/files", params: params, opts: opts, base_address: :api)
+    end
+
+    # Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to [access file contents](https://stripe.com/docs/file-upload#download-file-contents).
+    def retrieve(file, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/files/%<file>s", { file: CGI.escape(file) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end