mega-pure-kit 0.0.1

data/stripe-19.3.0/lib/stripe/resources/connect_collection_transfer.rb

@@ -0,0 +1,32 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class ConnectCollectionTransfer < APIResource
+    OBJECT_NAME = "connect_collection_transfer"
+    def self.object_name
+      "connect_collection_transfer"
+    end
+
+    # Amount transferred, in cents (or local equivalent).
+    attr_reader :amount
+    # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+    attr_reader :currency
+    # ID of the account that funds are being collected for.
+    attr_reader :destination
+    # Unique identifier for the object.
+    attr_reader :id
+    # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+    attr_reader :livemode
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+
+    def self.inner_class_types
+      @inner_class_types = {}
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
+  end
+end

data/stripe-19.3.0/lib/stripe/resources/country_spec.rb

@@ -0,0 +1,92 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # Stripe needs to collect certain pieces of information about each account
+  # created. These requirements can differ depending on the account's country. The
+  # Country Specs API makes these rules available to your integration.
+  #
+  # You can also view the information from this API call as [an online
+  # guide](https://docs.stripe.com/docs/connect/required-verification-information).
+  class CountrySpec < APIResource
+    extend Stripe::APIOperations::List
+
+    OBJECT_NAME = "country_spec"
+    def self.object_name
+      "country_spec"
+    end
+
+    class VerificationFields < ::Stripe::StripeObject
+      class Company < ::Stripe::StripeObject
+        # Additional fields which are only required for some users.
+        attr_reader :additional
+        # Fields which every account must eventually provide.
+        attr_reader :minimum
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Individual < ::Stripe::StripeObject
+        # Additional fields which are only required for some users.
+        attr_reader :additional
+        # Fields which every account must eventually provide.
+        attr_reader :minimum
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Attribute for field company
+      attr_reader :company
+      # Attribute for field individual
+      attr_reader :individual
+
+      def self.inner_class_types
+        @inner_class_types = { company: Company, individual: Individual }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+    # The default currency for this country. This applies to both payment methods and bank accounts.
+    attr_reader :default_currency
+    # Unique identifier for the object. Represented as the ISO country code for this country.
+    attr_reader :id
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # Currencies that can be accepted in the specific country (for transfers).
+    attr_reader :supported_bank_account_currencies
+    # Currencies that can be accepted in the specified country (for payments).
+    attr_reader :supported_payment_currencies
+    # Payment methods available in the specified country. You may need to enable some payment methods (e.g., [ACH](https://stripe.com/docs/ach)) on your account before they appear in this list. The `stripe` payment method refers to [charging through your platform](https://stripe.com/docs/connect/destination-charges).
+    attr_reader :supported_payment_methods
+    # Countries that can accept transfers from the specified country.
+    attr_reader :supported_transfer_countries
+    # Attribute for field verification_fields
+    attr_reader :verification_fields
+
+    # Lists all Country Spec objects available in the API.
+    def self.list(params = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/country_specs", params: params, opts: opts)
+    end
+
+    def self.inner_class_types
+      @inner_class_types = { verification_fields: VerificationFields }
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
+  end
+end

data/stripe-19.3.0/lib/stripe/resources/coupon.rb

@@ -0,0 +1,131 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # A coupon contains information about a percent-off or amount-off discount you
+  # might want to apply to a customer. Coupons may be applied to [subscriptions](https://api.stripe.com#subscriptions), [invoices](https://api.stripe.com#invoices),
+  # [checkout sessions](https://docs.stripe.com/api/checkout/sessions), [quotes](https://api.stripe.com#quotes), and more. Coupons do not work with conventional one-off [charges](https://docs.stripe.com/api/charges/create) or [payment intents](https://docs.stripe.com/api/payment_intents).
+  class Coupon < APIResource
+    extend Stripe::APIOperations::Create
+    include Stripe::APIOperations::Delete
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+
+    OBJECT_NAME = "coupon"
+    def self.object_name
+      "coupon"
+    end
+
+    class AppliesTo < ::Stripe::StripeObject
+      # A list of product IDs this coupon applies to
+      attr_reader :products
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class CurrencyOptions < ::Stripe::StripeObject
+      # Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer.
+      attr_reader :amount_off
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+    # Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer.
+    attr_reader :amount_off
+    # Attribute for field applies_to
+    attr_reader :applies_to
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    attr_reader :created
+    # If `amount_off` has been set, the three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the amount to take off.
+    attr_reader :currency
+    # Coupons defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
+    attr_reader :currency_options
+    # Always true for a deleted object
+    attr_reader :deleted
+    # One of `forever`, `once`, or `repeating`. Describes how long a customer who applies this coupon will get the discount.
+    attr_reader :duration
+    # If `duration` is `repeating`, the number of months the coupon applies. Null if coupon `duration` is `forever` or `once`.
+    attr_reader :duration_in_months
+    # Unique identifier for the object.
+    attr_reader :id
+    # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+    attr_reader :livemode
+    # Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.
+    attr_reader :max_redemptions
+    # Set of [key-value pairs](https://docs.stripe.com/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
+    # Name of the coupon displayed to customers on for instance invoices or receipts.
+    attr_reader :name
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a $ (or local equivalent)100 invoice $ (or local equivalent)50 instead.
+    attr_reader :percent_off
+    # Date after which the coupon can no longer be redeemed.
+    attr_reader :redeem_by
+    # Number of times this coupon has been applied to a customer.
+    attr_reader :times_redeemed
+    # Taking account of the above properties, whether this coupon can still be applied to a customer.
+    attr_reader :valid
+
+    # You can create coupons easily via the [coupon management](https://dashboard.stripe.com/coupons) page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.
+    #
+    # A coupon has either a percent_off or an amount_off and currency. If you set an amount_off, that amount will be subtracted from any invoice's subtotal. For example, an invoice with a subtotal of 100 will have a final total of 0 if a coupon with an amount_off of 200 is applied to it and an invoice with a subtotal of 300 will have a final total of 100 if a coupon with an amount_off of 200 is applied to it.
+    def self.create(params = {}, opts = {})
+      request_stripe_object(method: :post, path: "/v1/coupons", params: params, opts: opts)
+    end
+
+    # You can delete coupons via the [coupon management](https://dashboard.stripe.com/coupons) page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can't redeem the coupon. You can also delete coupons via the API.
+    def self.delete(coupon, params = {}, opts = {})
+      request_stripe_object(
+        method: :delete,
+        path: format("/v1/coupons/%<coupon>s", { coupon: CGI.escape(coupon) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # You can delete coupons via the [coupon management](https://dashboard.stripe.com/coupons) page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can't redeem the coupon. You can also delete coupons via the API.
+    def delete(params = {}, opts = {})
+      request_stripe_object(
+        method: :delete,
+        path: format("/v1/coupons/%<coupon>s", { coupon: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Returns a list of your coupons.
+    def self.list(params = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/coupons", params: params, opts: opts)
+    end
+
+    # Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.
+    def self.update(coupon, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/coupons/%<coupon>s", { coupon: CGI.escape(coupon) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.inner_class_types
+      @inner_class_types = { applies_to: AppliesTo, currency_options: CurrencyOptions }
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
+  end
+end

data/stripe-19.3.0/lib/stripe/resources/credit_note.rb

@@ -0,0 +1,317 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # Issue a credit note to adjust an invoice's amount after the invoice is finalized.
+  #
+  # Related guide: [Credit notes](https://docs.stripe.com/billing/invoices/credit-notes)
+  class CreditNote < APIResource
+    extend Stripe::APIOperations::Create
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+
+    OBJECT_NAME = "credit_note"
+    def self.object_name
+      "credit_note"
+    end
+
+    class DiscountAmount < ::Stripe::StripeObject
+      # The amount, in cents (or local equivalent), of the discount.
+      attr_reader :amount
+      # The discount that was applied to get this discount amount.
+      attr_reader :discount
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class PretaxCreditAmount < ::Stripe::StripeObject
+      # The amount, in cents (or local equivalent), of the pretax credit amount.
+      attr_reader :amount
+      # The credit balance transaction that was applied to get this pretax credit amount.
+      attr_reader :credit_balance_transaction
+      # The discount that was applied to get this pretax credit amount.
+      attr_reader :discount
+      # Type of the pretax credit amount referenced.
+      attr_reader :type
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class Refund < ::Stripe::StripeObject
+      class PaymentRecordRefund < ::Stripe::StripeObject
+        # ID of the payment record.
+        attr_reader :payment_record
+        # ID of the refund group.
+        attr_reader :refund_group
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Amount of the refund that applies to this credit note, in cents (or local equivalent).
+      attr_reader :amount_refunded
+      # The PaymentRecord refund details associated with this credit note refund.
+      attr_reader :payment_record_refund
+      # ID of the refund.
+      attr_reader :refund
+      # Type of the refund, one of `refund` or `payment_record_refund`.
+      attr_reader :type
+
+      def self.inner_class_types
+        @inner_class_types = { payment_record_refund: PaymentRecordRefund }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class ShippingCost < ::Stripe::StripeObject
+      class Tax < ::Stripe::StripeObject
+        # Amount of tax applied for this rate.
+        attr_reader :amount
+        # Tax rates can be applied to [invoices](/invoicing/taxes/tax-rates), [subscriptions](/billing/taxes/tax-rates) and [Checkout Sessions](/payments/checkout/use-manual-tax-rates) to collect tax.
+        #
+        # Related guide: [Tax rates](/billing/taxes/tax-rates)
+        attr_reader :rate
+        # The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
+        attr_reader :taxability_reason
+        # The amount on which tax is calculated, in cents (or local equivalent).
+        attr_reader :taxable_amount
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Total shipping cost before any taxes are applied.
+      attr_reader :amount_subtotal
+      # Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.
+      attr_reader :amount_tax
+      # Total shipping cost after taxes are applied.
+      attr_reader :amount_total
+      # The ID of the ShippingRate for this invoice.
+      attr_reader :shipping_rate
+      # The taxes applied to the shipping rate.
+      attr_reader :taxes
+
+      def self.inner_class_types
+        @inner_class_types = { taxes: Tax }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class TotalTax < ::Stripe::StripeObject
+      class TaxRateDetails < ::Stripe::StripeObject
+        # ID of the tax rate
+        attr_reader :tax_rate
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # The amount of the tax, in cents (or local equivalent).
+      attr_reader :amount
+      # Whether this tax is inclusive or exclusive.
+      attr_reader :tax_behavior
+      # Additional details about the tax rate. Only present when `type` is `tax_rate_details`.
+      attr_reader :tax_rate_details
+      # The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
+      attr_reader :taxability_reason
+      # The amount on which tax is calculated, in cents (or local equivalent).
+      attr_reader :taxable_amount
+      # The type of tax information.
+      attr_reader :type
+
+      def self.inner_class_types
+        @inner_class_types = { tax_rate_details: TaxRateDetails }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+    # The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax.
+    attr_reader :amount
+    # This is the sum of all the shipping amounts.
+    attr_reader :amount_shipping
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    attr_reader :created
+    # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+    attr_reader :currency
+    # ID of the customer.
+    attr_reader :customer
+    # ID of the account representing the customer.
+    attr_reader :customer_account
+    # Customer balance transaction related to this credit note.
+    attr_reader :customer_balance_transaction
+    # The integer amount in cents (or local equivalent) representing the total amount of discount that was credited.
+    attr_reader :discount_amount
+    # The aggregate amounts calculated per discount for all line items.
+    attr_reader :discount_amounts
+    # The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
+    attr_reader :effective_at
+    # Unique identifier for the object.
+    attr_reader :id
+    # ID of the invoice.
+    attr_reader :invoice
+    # Line items that make up the credit note
+    attr_reader :lines
+    # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+    attr_reader :livemode
+    # Customer-facing text that appears on the credit note PDF.
+    attr_reader :memo
+    # Set of [key-value pairs](https://docs.stripe.com/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
+    # A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice.
+    attr_reader :number
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # Amount that was credited outside of Stripe.
+    attr_reader :out_of_band_amount
+    # The link to download the PDF of the credit note.
+    attr_reader :pdf
+    # The amount of the credit note that was refunded to the customer, credited to the customer's balance, credited outside of Stripe, or any combination thereof.
+    attr_reader :post_payment_amount
+    # The amount of the credit note by which the invoice's `amount_remaining` and `amount_due` were reduced.
+    attr_reader :pre_payment_amount
+    # The pretax credit amounts (ex: discount, credit grants, etc) for all line items.
+    attr_reader :pretax_credit_amounts
+    # Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`
+    attr_reader :reason
+    # Refunds related to this credit note.
+    attr_reader :refunds
+    # The details of the cost of shipping, including the ShippingRate applied to the invoice.
+    attr_reader :shipping_cost
+    # Status of this credit note, one of `issued` or `void`. Learn more about [voiding credit notes](https://docs.stripe.com/billing/invoices/credit-notes#voiding).
+    attr_reader :status
+    # The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts.
+    attr_reader :subtotal
+    # The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts.
+    attr_reader :subtotal_excluding_tax
+    # The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount.
+    attr_reader :total
+    # The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts.
+    attr_reader :total_excluding_tax
+    # The aggregate tax information for all line items.
+    attr_reader :total_taxes
+    # Type of this credit note, one of `pre_payment` or `post_payment`. A `pre_payment` credit note means it was issued when the invoice was open. A `post_payment` credit note means it was issued when the invoice was paid.
+    attr_reader :type
+    # The time that the credit note was voided.
+    attr_reader :voided_at
+
+    # Issue a credit note to adjust the amount of a finalized invoice. A credit note will first reduce the invoice's amount_remaining (and amount_due), but not below zero.
+    # This amount is indicated by the credit note's pre_payment_amount. The excess amount is indicated by post_payment_amount, and it can result in any combination of the following:
+    #
+    #
+    # Refunds: create a new refund (using refund_amount) or link existing refunds (using refunds).
+    # Customer balance credit: credit the customer's balance (using credit_amount) which will be automatically applied to their next invoice when it's finalized.
+    # Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using out_of_band_amount).
+    #
+    #
+    # The sum of refunds, customer balance credits, and outside of Stripe credits must equal the post_payment_amount.
+    #
+    # You may issue multiple credit notes for an invoice. Each credit note may increment the invoice's pre_payment_credit_notes_amount,
+    # post_payment_credit_notes_amount, or both, depending on the invoice's amount_remaining at the time of credit note creation.
+    #
+    # For invoices that also have refunds created through the [Refund API](https://docs.stripe.com/docs/api/refunds), the credit note API subtracts those refund amounts from the maximum creditable amount. This prevents the combined credit notes and refunds from exceeding the invoice amount. If you use both, ensure the combined total does not exceed the invoice's paid amount.
+    def self.create(params = {}, opts = {})
+      request_stripe_object(method: :post, path: "/v1/credit_notes", params: params, opts: opts)
+    end
+
+    # Returns a list of credit notes.
+    def self.list(params = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/credit_notes", params: params, opts: opts)
+    end
+
+    # When retrieving a credit note preview, you'll get a lines property containing the first handful of those items. This URL you can retrieve the full (paginated) list of line items.
+    def self.list_preview_line_items(params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: "/v1/credit_notes/preview/lines",
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Get a preview of a credit note without creating it.
+    def self.preview(params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: "/v1/credit_notes/preview",
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Updates an existing credit note.
+    def self.update(id, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/credit_notes/%<id>s", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Marks a credit note as void. Learn more about [voiding credit notes](https://docs.stripe.com/docs/billing/invoices/credit-notes#voiding).
+    def void_credit_note(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/credit_notes/%<id>s/void", { id: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Marks a credit note as void. Learn more about [voiding credit notes](https://docs.stripe.com/docs/billing/invoices/credit-notes#voiding).
+    def self.void_credit_note(id, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/credit_notes/%<id>s/void", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.inner_class_types
+      @inner_class_types = {
+        discount_amounts: DiscountAmount,
+        pretax_credit_amounts: PretaxCreditAmount,
+        refunds: Refund,
+        shipping_cost: ShippingCost,
+        total_taxes: TotalTax,
+      }
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
+  end
+end