stripe 13.4.1 → 17.0.1

data/lib/stripe/params/issuing/dispute_update_params.rb

@@ -0,0 +1,275 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    class DisputeUpdateParams < Stripe::RequestParams
+      class Evidence < Stripe::RequestParams
+        class Canceled < Stripe::RequestParams
+          # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
+          attr_accessor :additional_documentation
+          # Date when order was canceled.
+          attr_accessor :canceled_at
+          # Whether the cardholder was provided with a cancellation policy.
+          attr_accessor :cancellation_policy_provided
+          # Reason for canceling the order.
+          attr_accessor :cancellation_reason
+          # Date when the cardholder expected to receive the product.
+          attr_accessor :expected_at
+          # Explanation of why the cardholder is disputing this transaction.
+          attr_accessor :explanation
+          # Description of the merchandise or service that was purchased.
+          attr_accessor :product_description
+          # Whether the product was a merchandise or service.
+          attr_accessor :product_type
+          # Result of cardholder's attempt to return the product.
+          attr_accessor :return_status
+          # Date when the product was returned or attempted to be returned.
+          attr_accessor :returned_at
+
+          def initialize(
+            additional_documentation: nil,
+            canceled_at: nil,
+            cancellation_policy_provided: nil,
+            cancellation_reason: nil,
+            expected_at: nil,
+            explanation: nil,
+            product_description: nil,
+            product_type: nil,
+            return_status: nil,
+            returned_at: nil
+          )
+            @additional_documentation = additional_documentation
+            @canceled_at = canceled_at
+            @cancellation_policy_provided = cancellation_policy_provided
+            @cancellation_reason = cancellation_reason
+            @expected_at = expected_at
+            @explanation = explanation
+            @product_description = product_description
+            @product_type = product_type
+            @return_status = return_status
+            @returned_at = returned_at
+          end
+        end
+
+        class Duplicate < Stripe::RequestParams
+          # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
+          attr_accessor :additional_documentation
+          # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the card statement showing that the product had already been paid for.
+          attr_accessor :card_statement
+          # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the receipt showing that the product had been paid for in cash.
+          attr_accessor :cash_receipt
+          # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Image of the front and back of the check that was used to pay for the product.
+          attr_accessor :check_image
+          # Explanation of why the cardholder is disputing this transaction.
+          attr_accessor :explanation
+          # Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one.
+          attr_accessor :original_transaction
+
+          def initialize(
+            additional_documentation: nil,
+            card_statement: nil,
+            cash_receipt: nil,
+            check_image: nil,
+            explanation: nil,
+            original_transaction: nil
+          )
+            @additional_documentation = additional_documentation
+            @card_statement = card_statement
+            @cash_receipt = cash_receipt
+            @check_image = check_image
+            @explanation = explanation
+            @original_transaction = original_transaction
+          end
+        end
+
+        class Fraudulent < Stripe::RequestParams
+          # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
+          attr_accessor :additional_documentation
+          # Explanation of why the cardholder is disputing this transaction.
+          attr_accessor :explanation
+
+          def initialize(additional_documentation: nil, explanation: nil)
+            @additional_documentation = additional_documentation
+            @explanation = explanation
+          end
+        end
+
+        class MerchandiseNotAsDescribed < Stripe::RequestParams
+          # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
+          attr_accessor :additional_documentation
+          # Explanation of why the cardholder is disputing this transaction.
+          attr_accessor :explanation
+          # Date when the product was received.
+          attr_accessor :received_at
+          # Description of the cardholder's attempt to return the product.
+          attr_accessor :return_description
+          # Result of cardholder's attempt to return the product.
+          attr_accessor :return_status
+          # Date when the product was returned or attempted to be returned.
+          attr_accessor :returned_at
+
+          def initialize(
+            additional_documentation: nil,
+            explanation: nil,
+            received_at: nil,
+            return_description: nil,
+            return_status: nil,
+            returned_at: nil
+          )
+            @additional_documentation = additional_documentation
+            @explanation = explanation
+            @received_at = received_at
+            @return_description = return_description
+            @return_status = return_status
+            @returned_at = returned_at
+          end
+        end
+
+        class NoValidAuthorization < Stripe::RequestParams
+          # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
+          attr_accessor :additional_documentation
+          # Explanation of why the cardholder is disputing this transaction.
+          attr_accessor :explanation
+
+          def initialize(additional_documentation: nil, explanation: nil)
+            @additional_documentation = additional_documentation
+            @explanation = explanation
+          end
+        end
+
+        class NotReceived < Stripe::RequestParams
+          # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
+          attr_accessor :additional_documentation
+          # Date when the cardholder expected to receive the product.
+          attr_accessor :expected_at
+          # Explanation of why the cardholder is disputing this transaction.
+          attr_accessor :explanation
+          # Description of the merchandise or service that was purchased.
+          attr_accessor :product_description
+          # Whether the product was a merchandise or service.
+          attr_accessor :product_type
+
+          def initialize(
+            additional_documentation: nil,
+            expected_at: nil,
+            explanation: nil,
+            product_description: nil,
+            product_type: nil
+          )
+            @additional_documentation = additional_documentation
+            @expected_at = expected_at
+            @explanation = explanation
+            @product_description = product_description
+            @product_type = product_type
+          end
+        end
+
+        class Other < Stripe::RequestParams
+          # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
+          attr_accessor :additional_documentation
+          # Explanation of why the cardholder is disputing this transaction.
+          attr_accessor :explanation
+          # Description of the merchandise or service that was purchased.
+          attr_accessor :product_description
+          # Whether the product was a merchandise or service.
+          attr_accessor :product_type
+
+          def initialize(
+            additional_documentation: nil,
+            explanation: nil,
+            product_description: nil,
+            product_type: nil
+          )
+            @additional_documentation = additional_documentation
+            @explanation = explanation
+            @product_description = product_description
+            @product_type = product_type
+          end
+        end
+
+        class ServiceNotAsDescribed < Stripe::RequestParams
+          # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
+          attr_accessor :additional_documentation
+          # Date when order was canceled.
+          attr_accessor :canceled_at
+          # Reason for canceling the order.
+          attr_accessor :cancellation_reason
+          # Explanation of why the cardholder is disputing this transaction.
+          attr_accessor :explanation
+          # Date when the product was received.
+          attr_accessor :received_at
+
+          def initialize(
+            additional_documentation: nil,
+            canceled_at: nil,
+            cancellation_reason: nil,
+            explanation: nil,
+            received_at: nil
+          )
+            @additional_documentation = additional_documentation
+            @canceled_at = canceled_at
+            @cancellation_reason = cancellation_reason
+            @explanation = explanation
+            @received_at = received_at
+          end
+        end
+        # Evidence provided when `reason` is 'canceled'.
+        attr_accessor :canceled
+        # Evidence provided when `reason` is 'duplicate'.
+        attr_accessor :duplicate
+        # Evidence provided when `reason` is 'fraudulent'.
+        attr_accessor :fraudulent
+        # Evidence provided when `reason` is 'merchandise_not_as_described'.
+        attr_accessor :merchandise_not_as_described
+        # Evidence provided when `reason` is 'no_valid_authorization'.
+        attr_accessor :no_valid_authorization
+        # Evidence provided when `reason` is 'not_received'.
+        attr_accessor :not_received
+        # Evidence provided when `reason` is 'other'.
+        attr_accessor :other
+        # The reason for filing the dispute. The evidence should be submitted in the field of the same name.
+        attr_accessor :reason
+        # Evidence provided when `reason` is 'service_not_as_described'.
+        attr_accessor :service_not_as_described
+
+        def initialize(
+          canceled: nil,
+          duplicate: nil,
+          fraudulent: nil,
+          merchandise_not_as_described: nil,
+          no_valid_authorization: nil,
+          not_received: nil,
+          other: nil,
+          reason: nil,
+          service_not_as_described: nil
+        )
+          @canceled = canceled
+          @duplicate = duplicate
+          @fraudulent = fraudulent
+          @merchandise_not_as_described = merchandise_not_as_described
+          @no_valid_authorization = no_valid_authorization
+          @not_received = not_received
+          @other = other
+          @reason = reason
+          @service_not_as_described = service_not_as_described
+        end
+      end
+      # The dispute amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
+      attr_accessor :amount
+      # Evidence provided for the dispute.
+      attr_accessor :evidence
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # 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(amount: nil, evidence: nil, expand: nil, metadata: nil)
+        @amount = amount
+        @evidence = evidence
+        @expand = expand
+        @metadata = metadata
+      end
+    end
+  end
+end

data/lib/stripe/params/issuing/personalization_design_activate_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    class PersonalizationDesignActivateParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+  end
+end

data/lib/stripe/params/issuing/personalization_design_create_params.rb

@@ -0,0 +1,75 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    class PersonalizationDesignCreateParams < Stripe::RequestParams
+      class CarrierText < Stripe::RequestParams
+        # The footer body text of the carrier letter.
+        attr_accessor :footer_body
+        # The footer title text of the carrier letter.
+        attr_accessor :footer_title
+        # The header body text of the carrier letter.
+        attr_accessor :header_body
+        # The header title text of the carrier letter.
+        attr_accessor :header_title
+
+        def initialize(footer_body: nil, footer_title: nil, header_body: nil, header_title: nil)
+          @footer_body = footer_body
+          @footer_title = footer_title
+          @header_body = header_body
+          @header_title = header_title
+        end
+      end
+
+      class Preferences < Stripe::RequestParams
+        # Whether we use this personalization design to create cards when one isn't specified. A connected account uses the Connect platform's default design if no personalization design is set as the default design.
+        attr_accessor :is_default
+
+        def initialize(is_default: nil)
+          @is_default = is_default
+        end
+      end
+      # The file for the card logo, for use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`.
+      attr_accessor :card_logo
+      # Hash containing carrier text, for use with physical bundles that support carrier text.
+      attr_accessor :carrier_text
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.
+      attr_accessor :lookup_key
+      # 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
+      # Friendly display name.
+      attr_accessor :name
+      # The physical bundle object belonging to this personalization design.
+      attr_accessor :physical_bundle
+      # Information on whether this personalization design is used to create cards when one is not specified.
+      attr_accessor :preferences
+      # If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design.
+      attr_accessor :transfer_lookup_key
+
+      def initialize(
+        card_logo: nil,
+        carrier_text: nil,
+        expand: nil,
+        lookup_key: nil,
+        metadata: nil,
+        name: nil,
+        physical_bundle: nil,
+        preferences: nil,
+        transfer_lookup_key: nil
+      )
+        @card_logo = card_logo
+        @carrier_text = carrier_text
+        @expand = expand
+        @lookup_key = lookup_key
+        @metadata = metadata
+        @name = name
+        @physical_bundle = physical_bundle
+        @preferences = preferences
+        @transfer_lookup_key = transfer_lookup_key
+      end
+    end
+  end
+end

data/lib/stripe/params/issuing/personalization_design_deactivate_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    class PersonalizationDesignDeactivateParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+  end
+end

data/lib/stripe/params/issuing/personalization_design_list_params.rb

@@ -0,0 +1,52 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    class PersonalizationDesignListParams < Stripe::RequestParams
+      class Preferences < Stripe::RequestParams
+        # Only return the personalization design that's set as the default. A connected account uses the Connect platform's default design if no personalization design is set as the default.
+        attr_accessor :is_default
+        # Only return the personalization design that is set as the Connect platform's default. This parameter is only applicable to connected accounts.
+        attr_accessor :is_platform_default
+
+        def initialize(is_default: nil, is_platform_default: nil)
+          @is_default = is_default
+          @is_platform_default = is_platform_default
+        end
+      end
+      # 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
+      # Only return personalization designs with the given lookup keys.
+      attr_accessor :lookup_keys
+      # Only return personalization designs with the given preferences.
+      attr_accessor :preferences
+      # 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
+      # Only return personalization designs with the given status.
+      attr_accessor :status
+
+      def initialize(
+        ending_before: nil,
+        expand: nil,
+        limit: nil,
+        lookup_keys: nil,
+        preferences: nil,
+        starting_after: nil,
+        status: nil
+      )
+        @ending_before = ending_before
+        @expand = expand
+        @limit = limit
+        @lookup_keys = lookup_keys
+        @preferences = preferences
+        @starting_after = starting_after
+        @status = status
+      end
+    end
+  end
+end

data/lib/stripe/params/issuing/personalization_design_reject_params.rb

@@ -0,0 +1,29 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    class PersonalizationDesignRejectParams < Stripe::RequestParams
+      class RejectionReasons < Stripe::RequestParams
+        # The reason(s) the card logo was rejected.
+        attr_accessor :card_logo
+        # The reason(s) the carrier text was rejected.
+        attr_accessor :carrier_text
+
+        def initialize(card_logo: nil, carrier_text: nil)
+          @card_logo = card_logo
+          @carrier_text = carrier_text
+        end
+      end
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # The reason(s) the personalization design was rejected.
+      attr_accessor :rejection_reasons
+
+      def initialize(expand: nil, rejection_reasons: nil)
+        @expand = expand
+        @rejection_reasons = rejection_reasons
+      end
+    end
+  end
+end

data/lib/stripe/params/issuing/personalization_design_retrieve_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    class PersonalizationDesignRetrieveParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+  end
+end

data/lib/stripe/params/issuing/personalization_design_update_params.rb

@@ -0,0 +1,75 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    class PersonalizationDesignUpdateParams < Stripe::RequestParams
+      class CarrierText < Stripe::RequestParams
+        # The footer body text of the carrier letter.
+        attr_accessor :footer_body
+        # The footer title text of the carrier letter.
+        attr_accessor :footer_title
+        # The header body text of the carrier letter.
+        attr_accessor :header_body
+        # The header title text of the carrier letter.
+        attr_accessor :header_title
+
+        def initialize(footer_body: nil, footer_title: nil, header_body: nil, header_title: nil)
+          @footer_body = footer_body
+          @footer_title = footer_title
+          @header_body = header_body
+          @header_title = header_title
+        end
+      end
+
+      class Preferences < Stripe::RequestParams
+        # Whether we use this personalization design to create cards when one isn't specified. A connected account uses the Connect platform's default design if no personalization design is set as the default design.
+        attr_accessor :is_default
+
+        def initialize(is_default: nil)
+          @is_default = is_default
+        end
+      end
+      # The file for the card logo, for use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`.
+      attr_accessor :card_logo
+      # Hash containing carrier text, for use with physical bundles that support carrier text.
+      attr_accessor :carrier_text
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.
+      attr_accessor :lookup_key
+      # 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
+      # Friendly display name. Providing an empty string will set the field to null.
+      attr_accessor :name
+      # The physical bundle object belonging to this personalization design.
+      attr_accessor :physical_bundle
+      # Information on whether this personalization design is used to create cards when one is not specified.
+      attr_accessor :preferences
+      # If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design.
+      attr_accessor :transfer_lookup_key
+
+      def initialize(
+        card_logo: nil,
+        carrier_text: nil,
+        expand: nil,
+        lookup_key: nil,
+        metadata: nil,
+        name: nil,
+        physical_bundle: nil,
+        preferences: nil,
+        transfer_lookup_key: nil
+      )
+        @card_logo = card_logo
+        @carrier_text = carrier_text
+        @expand = expand
+        @lookup_key = lookup_key
+        @metadata = metadata
+        @name = name
+        @physical_bundle = physical_bundle
+        @preferences = preferences
+        @transfer_lookup_key = transfer_lookup_key
+      end
+    end
+  end
+end

data/lib/stripe/params/issuing/physical_bundle_list_params.rb

@@ -0,0 +1,37 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    class PhysicalBundleListParams < Stripe::RequestParams
+      # 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
+      # Only return physical bundles with the given status.
+      attr_accessor :status
+      # Only return physical bundles with the given type.
+      attr_accessor :type
+
+      def initialize(
+        ending_before: nil,
+        expand: nil,
+        limit: nil,
+        starting_after: nil,
+        status: nil,
+        type: nil
+      )
+        @ending_before = ending_before
+        @expand = expand
+        @limit = limit
+        @starting_after = starting_after
+        @status = status
+        @type = type
+      end
+    end
+  end
+end

data/lib/stripe/params/issuing/physical_bundle_retrieve_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    class PhysicalBundleRetrieveParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+  end
+end

data/lib/stripe/params/issuing/token_list_params.rb

@@ -0,0 +1,58 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    class TokenListParams < 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
+      # The Issuing card identifier to list tokens for.
+      attr_accessor :card
+      # Only return Issuing tokens 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
+      # 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
+      # Select Issuing tokens with the given status.
+      attr_accessor :status
+
+      def initialize(
+        card: nil,
+        created: nil,
+        ending_before: nil,
+        expand: nil,
+        limit: nil,
+        starting_after: nil,
+        status: nil
+      )
+        @card = card
+        @created = created
+        @ending_before = ending_before
+        @expand = expand
+        @limit = limit
+        @starting_after = starting_after
+        @status = status
+      end
+    end
+  end
+end