stripe 13.5.0 → 14.0.0

data/lib/stripe/resources/entitlements/active_entitlement_summary.rb

@@ -0,0 +1,23 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Entitlements
+    # A summary of a customer's active entitlements.
+    class ActiveEntitlementSummary < APIResource
+      OBJECT_NAME = "entitlements.active_entitlement_summary"
+      def self.object_name
+        "entitlements.active_entitlement_summary"
+      end
+
+      # The customer that is entitled to this feature.
+      attr_reader :customer
+      # The list of entitlements this customer has.
+      attr_reader :entitlements
+      # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+      attr_reader :livemode
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+    end
+  end
+end

data/lib/stripe/resources/entitlements/feature.rb

@@ -15,6 +15,87 @@ module Stripe
         "entitlements.feature"
       end
 
+      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 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
+      # Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
+      attr_reader :active
+      # Unique identifier for the object.
+      attr_reader :id
+      # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+      attr_reader :livemode
+      # A unique key you provide as your own system identifier. This may be up to 80 characters.
+      attr_reader :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_reader :metadata
+      # The feature's name, for your own purpose, not meant to be displayable to the customer.
+      attr_reader :name
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+
       # Creates a feature
       def self.create(params = {}, opts = {})
         request_stripe_object(

data/lib/stripe/resources/ephemeral_key.rb

@@ -11,6 +11,27 @@ module Stripe
       "ephemeral_key"
     end
 
+    class DeleteParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    attr_reader :created
+    # Time at which the key will expire. Measured in seconds since the Unix epoch.
+    attr_reader :expires
+    # Unique identifier for the object.
+    attr_reader :id
+    # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+    attr_reader :livemode
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # The key's secret. You can use this value to make authorized requests to the Stripe API.
+    attr_reader :secret
+
     # Invalidates a short-lived API key for a given resource.
     def self.delete(key, params = {}, opts = {})
       request_stripe_object(

data/lib/stripe/resources/event.rb

@@ -40,6 +40,96 @@ module Stripe
       "event"
     end
 
+    class Data < Stripe::StripeObject
+      # Object containing the API resource relevant to the event. For example, an `invoice.created` event will have a full [invoice object](https://stripe.com/docs/api#invoice_object) as the value of the object key.
+      attr_reader :object
+      # Object containing the names of the updated attributes and their values prior to the event (only included in events of type `*.updated`). If an array attribute has any updated elements, this object contains the entire array. In Stripe API versions 2017-04-06 or earlier, an updated array attribute in this object includes only the updated array elements.
+      attr_reader :previous_attributes
+    end
+
+    class Request < Stripe::StripeObject
+      # ID of the API request that caused the event. If null, the event was automatic (e.g., Stripe's automatic subscription handling). Request logs are available in the [dashboard](https://dashboard.stripe.com/logs), but currently not in the API.
+      attr_reader :id
+      # The idempotency key transmitted during the request, if any. *Note: This property is populated only for events on or after May 23, 2017*.
+      attr_reader :idempotency_key
+    end
+
+    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
+    # The connected account that originates the event.
+    attr_reader :account
+    # The Stripe API version used to render `data`. This property is populated only for events on or after October 31, 2014.
+    attr_reader :api_version
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    attr_reader :created
+    # Attribute for field data
+    attr_reader :data
+    # Unique identifier for the object.
+    attr_reader :id
+    # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+    attr_reader :livemode
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # Number of webhooks that haven't been successfully delivered (for example, to return a 20x response) to the URLs you specify.
+    attr_reader :pending_webhooks
+    # Information on the API request that triggers the event.
+    attr_reader :request
+    # Description of the event (for example, `invoice.created` or `charge.refunded`).
+    attr_reader :type
+
     # 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 self.list(params = {}, opts = {})
       request_stripe_object(method: :get, path: "/v1/events", params: params, opts: opts)

data/lib/stripe/resources/exchange_rate.rb

@@ -36,6 +36,30 @@ module Stripe
       "exchange_rate"
     end
 
+    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
+    # Unique identifier for the object. Represented as the three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) in lowercase.
+    attr_reader :id
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # Hash where the keys are supported currencies and the values are the exchange rate at which the base id currency converts to the key currency.
+    attr_reader :rates
+
     # 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 self.list(params = {}, opts = {})
       request_stripe_object(method: :get, path: "/v1/exchange_rates", params: params, opts: opts)

data/lib/stripe/resources/file.rb

@@ -18,6 +18,108 @@ module Stripe
       "file"
     end
 
+    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
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    attr_reader :created
+    # The file expires and isn't available at this time in epoch seconds.
+    attr_reader :expires_at
+    # The suitable name for saving the file to a filesystem.
+    attr_reader :filename
+    # Unique identifier for the object.
+    attr_reader :id
+    # A list of [file links](https://stripe.com/docs/api#file_links) that point at this file.
+    attr_reader :links
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file.
+    attr_reader :purpose
+    # The size of the file object in bytes.
+    attr_reader :size
+    # A suitable title for the document.
+    attr_reader :title
+    # The returned file type (for example, `csv`, `pdf`, `jpg`, or `png`).
+    attr_reader :type
+    # Use your live secret API key to download the file from this URL.
+    attr_reader :url
+
     # 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.

data/lib/stripe/resources/file_link.rb

@@ -15,6 +15,109 @@ module Stripe
       "file_link"
     end
 
+    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 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
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    attr_reader :created
+    # Returns if the link is already expired.
+    attr_reader :expired
+    # Time that the link expires.
+    attr_reader :expires_at
+    # The file object this link points to.
+    attr_reader :file
+    # Unique identifier for the object.
+    attr_reader :id
+    # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+    attr_reader :livemode
+    # 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.
+    attr_reader :metadata
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # The publicly accessible URL to download the file.
+    attr_reader :url
+
     # Creates a new file link object.
     def self.create(params = {}, opts = {})
       request_stripe_object(method: :post, path: "/v1/file_links", params: params, opts: opts)