stripe 22.1.0 → 22.2.0-alpha.2

package/cjs/resources/Persons.d.ts

@@ -106,6 +106,8 @@ export interface Person {
      * Information about the requirements for this person, including what information needs to be collected, and by when.
      */
     requirements?: Person.Requirements | null;
+    self_reported_income?: Person.SelfReportedIncome;
+    self_reported_monthly_housing_payment?: Person.SelfReportedMonthlyHousingPayment;
     /**
      * Whether the last four digits of the person's Social Security number have been provided (U.S. only).
      */
@@ -298,6 +300,26 @@ export declare namespace Person {
          */
         pending_verification: Array<string>;
     }
+    interface SelfReportedIncome {
+        /**
+         * The amount in the minor currency unit (for example, cents for USD).
+         */
+        amount: number;
+        /**
+         * 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).
+         */
+        currency: string;
+    }
+    interface SelfReportedMonthlyHousingPayment {
+        /**
+         * The amount in the minor currency unit (for example, cents for USD).
+         */
+        amount: number;
+        /**
+         * 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).
+         */
+        currency: string;
+    }
     interface UsCfpbData {
         /**
          * The persons ethnicity details
@@ -373,7 +395,7 @@ export declare namespace Person {
             requirement: string;
         }
         namespace Error {
-            type Code = 'external_request' | 'information_missing' | 'invalid_address_city_state_postal_code' | 'invalid_address_highway_contract_box' | 'invalid_address_private_mailbox' | 'invalid_business_profile_name' | 'invalid_business_profile_name_denylisted' | 'invalid_company_name_denylisted' | 'invalid_dob_age_over_maximum' | 'invalid_dob_age_under_18' | 'invalid_dob_age_under_minimum' | 'invalid_product_description_length' | 'invalid_product_description_url_match' | 'invalid_representative_country' | 'invalid_signator' | 'invalid_statement_descriptor_business_mismatch' | 'invalid_statement_descriptor_denylisted' | 'invalid_statement_descriptor_length' | 'invalid_statement_descriptor_prefix_denylisted' | 'invalid_statement_descriptor_prefix_mismatch' | 'invalid_street_address' | 'invalid_tax_id' | 'invalid_tax_id_format' | 'invalid_tos_acceptance' | 'invalid_url_denylisted' | 'invalid_url_format' | 'invalid_url_length' | 'invalid_url_web_presence_detected' | 'invalid_url_website_business_information_mismatch' | 'invalid_url_website_empty' | 'invalid_url_website_inaccessible' | 'invalid_url_website_inaccessible_geoblocked' | 'invalid_url_website_inaccessible_password_protected' | 'invalid_url_website_incomplete' | 'invalid_url_website_incomplete_cancellation_policy' | 'invalid_url_website_incomplete_customer_service_details' | 'invalid_url_website_incomplete_legal_restrictions' | 'invalid_url_website_incomplete_refund_policy' | 'invalid_url_website_incomplete_return_policy' | 'invalid_url_website_incomplete_terms_and_conditions' | 'invalid_url_website_incomplete_under_construction' | 'invalid_url_website_other' | 'invalid_value_other' | 'unsupported_business_type' | 'verification_directors_mismatch' | 'verification_document_address_mismatch' | 'verification_document_address_missing' | 'verification_document_corrupt' | 'verification_document_country_not_supported' | 'verification_document_directors_mismatch' | 'verification_document_dob_mismatch' | 'verification_document_duplicate_type' | 'verification_document_expired' | 'verification_document_failed_copy' | 'verification_document_failed_greyscale' | 'verification_document_failed_other' | 'verification_document_failed_test_mode' | 'verification_document_fraudulent' | 'verification_document_id_number_mismatch' | 'verification_document_id_number_missing' | 'verification_document_incomplete' | 'verification_document_invalid' | 'verification_document_issue_or_expiry_date_missing' | 'verification_document_manipulated' | 'verification_document_missing_back' | 'verification_document_missing_front' | 'verification_document_name_mismatch' | 'verification_document_name_missing' | 'verification_document_nationality_mismatch' | 'verification_document_not_readable' | 'verification_document_not_signed' | 'verification_document_not_uploaded' | 'verification_document_photo_mismatch' | 'verification_document_too_large' | 'verification_document_type_not_supported' | 'verification_extraneous_directors' | 'verification_failed_address_match' | 'verification_failed_authorizer_authority' | 'verification_failed_business_iec_number' | 'verification_failed_document_match' | 'verification_failed_id_number_match' | 'verification_failed_keyed_identity' | 'verification_failed_keyed_match' | 'verification_failed_name_match' | 'verification_failed_other' | 'verification_failed_representative_authority' | 'verification_failed_residential_address' | 'verification_failed_tax_id_match' | 'verification_failed_tax_id_not_issued' | 'verification_legal_entity_structure_mismatch' | 'verification_missing_directors' | 'verification_missing_executives' | 'verification_missing_owners' | 'verification_rejected_ownership_exemption_reason' | 'verification_requires_additional_memorandum_of_associations' | 'verification_requires_additional_proof_of_registration' | 'verification_supportability';
+            type Code = 'external_request' | 'information_missing' | 'invalid_address_city_state_postal_code' | 'invalid_address_highway_contract_box' | 'invalid_address_private_mailbox' | 'invalid_business_profile_name' | 'invalid_business_profile_name_denylisted' | 'invalid_company_name_denylisted' | 'invalid_dob_age_over_maximum' | 'invalid_dob_age_under_18' | 'invalid_dob_age_under_minimum' | 'invalid_product_description_length' | 'invalid_product_description_url_match' | 'invalid_representative_country' | 'invalid_signator' | 'invalid_statement_descriptor_business_mismatch' | 'invalid_statement_descriptor_denylisted' | 'invalid_statement_descriptor_length' | 'invalid_statement_descriptor_prefix_denylisted' | 'invalid_statement_descriptor_prefix_mismatch' | 'invalid_street_address' | 'invalid_tax_id' | 'invalid_tax_id_format' | 'invalid_tos_acceptance' | 'invalid_url_denylisted' | 'invalid_url_format' | 'invalid_url_length' | 'invalid_url_web_presence_detected' | 'invalid_url_website_business_information_mismatch' | 'invalid_url_website_empty' | 'invalid_url_website_inaccessible' | 'invalid_url_website_inaccessible_geoblocked' | 'invalid_url_website_inaccessible_password_protected' | 'invalid_url_website_incomplete' | 'invalid_url_website_incomplete_cancellation_policy' | 'invalid_url_website_incomplete_customer_service_details' | 'invalid_url_website_incomplete_legal_restrictions' | 'invalid_url_website_incomplete_refund_policy' | 'invalid_url_website_incomplete_return_policy' | 'invalid_url_website_incomplete_terms_and_conditions' | 'invalid_url_website_incomplete_under_construction' | 'invalid_url_website_other' | 'invalid_value_other' | 'unsupported_business_type' | 'verification_data_not_found' | 'verification_directors_mismatch' | 'verification_document_address_mismatch' | 'verification_document_address_missing' | 'verification_document_corrupt' | 'verification_document_country_not_supported' | 'verification_document_directors_mismatch' | 'verification_document_dob_mismatch' | 'verification_document_duplicate_type' | 'verification_document_expired' | 'verification_document_failed_copy' | 'verification_document_failed_greyscale' | 'verification_document_failed_other' | 'verification_document_failed_test_mode' | 'verification_document_fraudulent' | 'verification_document_id_number_mismatch' | 'verification_document_id_number_missing' | 'verification_document_incomplete' | 'verification_document_invalid' | 'verification_document_issue_or_expiry_date_missing' | 'verification_document_manipulated' | 'verification_document_missing_back' | 'verification_document_missing_front' | 'verification_document_name_mismatch' | 'verification_document_name_missing' | 'verification_document_nationality_mismatch' | 'verification_document_not_readable' | 'verification_document_not_signed' | 'verification_document_not_uploaded' | 'verification_document_photo_mismatch' | 'verification_document_too_large' | 'verification_document_type_not_supported' | 'verification_extraneous_directors' | 'verification_failed_address_match' | 'verification_failed_authorizer_authority' | 'verification_failed_business_iec_number' | 'verification_failed_document_match' | 'verification_failed_id_number_match' | 'verification_failed_keyed_identity' | 'verification_failed_keyed_match' | 'verification_failed_name_match' | 'verification_failed_other' | 'verification_failed_representative_authority' | 'verification_failed_residential_address' | 'verification_failed_tax_id_match' | 'verification_failed_tax_id_not_issued' | 'verification_legal_entity_structure_mismatch' | 'verification_missing_directors' | 'verification_missing_executives' | 'verification_missing_owners' | 'verification_rejected_ownership_exemption_reason' | 'verification_requires_additional_memorandum_of_associations' | 'verification_requires_additional_proof_of_registration' | 'verification_supportability';
         }
     }
     namespace Requirements {
@@ -402,7 +424,7 @@ export declare namespace Person {
             requirement: string;
         }
         namespace Error {
-            type Code = 'external_request' | 'information_missing' | 'invalid_address_city_state_postal_code' | 'invalid_address_highway_contract_box' | 'invalid_address_private_mailbox' | 'invalid_business_profile_name' | 'invalid_business_profile_name_denylisted' | 'invalid_company_name_denylisted' | 'invalid_dob_age_over_maximum' | 'invalid_dob_age_under_18' | 'invalid_dob_age_under_minimum' | 'invalid_product_description_length' | 'invalid_product_description_url_match' | 'invalid_representative_country' | 'invalid_signator' | 'invalid_statement_descriptor_business_mismatch' | 'invalid_statement_descriptor_denylisted' | 'invalid_statement_descriptor_length' | 'invalid_statement_descriptor_prefix_denylisted' | 'invalid_statement_descriptor_prefix_mismatch' | 'invalid_street_address' | 'invalid_tax_id' | 'invalid_tax_id_format' | 'invalid_tos_acceptance' | 'invalid_url_denylisted' | 'invalid_url_format' | 'invalid_url_length' | 'invalid_url_web_presence_detected' | 'invalid_url_website_business_information_mismatch' | 'invalid_url_website_empty' | 'invalid_url_website_inaccessible' | 'invalid_url_website_inaccessible_geoblocked' | 'invalid_url_website_inaccessible_password_protected' | 'invalid_url_website_incomplete' | 'invalid_url_website_incomplete_cancellation_policy' | 'invalid_url_website_incomplete_customer_service_details' | 'invalid_url_website_incomplete_legal_restrictions' | 'invalid_url_website_incomplete_refund_policy' | 'invalid_url_website_incomplete_return_policy' | 'invalid_url_website_incomplete_terms_and_conditions' | 'invalid_url_website_incomplete_under_construction' | 'invalid_url_website_other' | 'invalid_value_other' | 'unsupported_business_type' | 'verification_directors_mismatch' | 'verification_document_address_mismatch' | 'verification_document_address_missing' | 'verification_document_corrupt' | 'verification_document_country_not_supported' | 'verification_document_directors_mismatch' | 'verification_document_dob_mismatch' | 'verification_document_duplicate_type' | 'verification_document_expired' | 'verification_document_failed_copy' | 'verification_document_failed_greyscale' | 'verification_document_failed_other' | 'verification_document_failed_test_mode' | 'verification_document_fraudulent' | 'verification_document_id_number_mismatch' | 'verification_document_id_number_missing' | 'verification_document_incomplete' | 'verification_document_invalid' | 'verification_document_issue_or_expiry_date_missing' | 'verification_document_manipulated' | 'verification_document_missing_back' | 'verification_document_missing_front' | 'verification_document_name_mismatch' | 'verification_document_name_missing' | 'verification_document_nationality_mismatch' | 'verification_document_not_readable' | 'verification_document_not_signed' | 'verification_document_not_uploaded' | 'verification_document_photo_mismatch' | 'verification_document_too_large' | 'verification_document_type_not_supported' | 'verification_extraneous_directors' | 'verification_failed_address_match' | 'verification_failed_authorizer_authority' | 'verification_failed_business_iec_number' | 'verification_failed_document_match' | 'verification_failed_id_number_match' | 'verification_failed_keyed_identity' | 'verification_failed_keyed_match' | 'verification_failed_name_match' | 'verification_failed_other' | 'verification_failed_representative_authority' | 'verification_failed_residential_address' | 'verification_failed_tax_id_match' | 'verification_failed_tax_id_not_issued' | 'verification_legal_entity_structure_mismatch' | 'verification_missing_directors' | 'verification_missing_executives' | 'verification_missing_owners' | 'verification_rejected_ownership_exemption_reason' | 'verification_requires_additional_memorandum_of_associations' | 'verification_requires_additional_proof_of_registration' | 'verification_supportability';
+            type Code = 'external_request' | 'information_missing' | 'invalid_address_city_state_postal_code' | 'invalid_address_highway_contract_box' | 'invalid_address_private_mailbox' | 'invalid_business_profile_name' | 'invalid_business_profile_name_denylisted' | 'invalid_company_name_denylisted' | 'invalid_dob_age_over_maximum' | 'invalid_dob_age_under_18' | 'invalid_dob_age_under_minimum' | 'invalid_product_description_length' | 'invalid_product_description_url_match' | 'invalid_representative_country' | 'invalid_signator' | 'invalid_statement_descriptor_business_mismatch' | 'invalid_statement_descriptor_denylisted' | 'invalid_statement_descriptor_length' | 'invalid_statement_descriptor_prefix_denylisted' | 'invalid_statement_descriptor_prefix_mismatch' | 'invalid_street_address' | 'invalid_tax_id' | 'invalid_tax_id_format' | 'invalid_tos_acceptance' | 'invalid_url_denylisted' | 'invalid_url_format' | 'invalid_url_length' | 'invalid_url_web_presence_detected' | 'invalid_url_website_business_information_mismatch' | 'invalid_url_website_empty' | 'invalid_url_website_inaccessible' | 'invalid_url_website_inaccessible_geoblocked' | 'invalid_url_website_inaccessible_password_protected' | 'invalid_url_website_incomplete' | 'invalid_url_website_incomplete_cancellation_policy' | 'invalid_url_website_incomplete_customer_service_details' | 'invalid_url_website_incomplete_legal_restrictions' | 'invalid_url_website_incomplete_refund_policy' | 'invalid_url_website_incomplete_return_policy' | 'invalid_url_website_incomplete_terms_and_conditions' | 'invalid_url_website_incomplete_under_construction' | 'invalid_url_website_other' | 'invalid_value_other' | 'unsupported_business_type' | 'verification_data_not_found' | 'verification_directors_mismatch' | 'verification_document_address_mismatch' | 'verification_document_address_missing' | 'verification_document_corrupt' | 'verification_document_country_not_supported' | 'verification_document_directors_mismatch' | 'verification_document_dob_mismatch' | 'verification_document_duplicate_type' | 'verification_document_expired' | 'verification_document_failed_copy' | 'verification_document_failed_greyscale' | 'verification_document_failed_other' | 'verification_document_failed_test_mode' | 'verification_document_fraudulent' | 'verification_document_id_number_mismatch' | 'verification_document_id_number_missing' | 'verification_document_incomplete' | 'verification_document_invalid' | 'verification_document_issue_or_expiry_date_missing' | 'verification_document_manipulated' | 'verification_document_missing_back' | 'verification_document_missing_front' | 'verification_document_name_mismatch' | 'verification_document_name_missing' | 'verification_document_nationality_mismatch' | 'verification_document_not_readable' | 'verification_document_not_signed' | 'verification_document_not_uploaded' | 'verification_document_photo_mismatch' | 'verification_document_too_large' | 'verification_document_type_not_supported' | 'verification_extraneous_directors' | 'verification_failed_address_match' | 'verification_failed_authorizer_authority' | 'verification_failed_business_iec_number' | 'verification_failed_document_match' | 'verification_failed_id_number_match' | 'verification_failed_keyed_identity' | 'verification_failed_keyed_match' | 'verification_failed_name_match' | 'verification_failed_other' | 'verification_failed_representative_authority' | 'verification_failed_residential_address' | 'verification_failed_tax_id_match' | 'verification_failed_tax_id_not_issued' | 'verification_legal_entity_structure_mismatch' | 'verification_missing_directors' | 'verification_missing_executives' | 'verification_missing_owners' | 'verification_rejected_ownership_exemption_reason' | 'verification_requires_additional_memorandum_of_associations' | 'verification_requires_additional_proof_of_registration' | 'verification_supportability';
         }
     }
     namespace UsCfpbData {

package/cjs/resources/Plans.d.ts

@@ -266,6 +266,10 @@ export declare namespace PlanCreateParams {
          * A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
          */
         tax_code?: string;
+        /**
+         * Tax details for this product, including the [tax code](https://docs.stripe.com/tax/tax-codes) and an optional performance location.
+         */
+        tax_details?: Product.TaxDetails;
         /**
          * A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
          */
@@ -305,6 +309,18 @@ export declare namespace PlanCreateParams {
         round: TransformUsage.Round;
     }
     type UsageType = 'licensed' | 'metered';
+    namespace Product {
+        interface TaxDetails {
+            /**
+             * A tax location ID. Depending on the [tax code](https://docs.stripe.com/tax/tax-for-tickets/reference/tax-location-performance), this is required, optional, or not supported.
+             */
+            performance_location?: string;
+            /**
+             * A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
+             */
+            tax_code?: Emptyable<string>;
+        }
+    }
     namespace TransformUsage {
         type Round = 'down' | 'up';
     }

package/cjs/resources/Prices.d.ts

@@ -66,6 +66,10 @@ export interface Price {
      * Always true for a deleted object
      */
     deleted?: void;
+    /**
+     * A custom identifier for this price, such as a SKU number or product code, that can be used to reference records from external systems.
+     */
+    external_reference?: string | null;
     /**
      * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
      */
@@ -78,6 +82,10 @@ export interface Price {
      * 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.
      */
     metadata: Metadata;
+    /**
+     * Subscriptions using this price will be migrated to use the new referenced price.
+     */
+    migrate_to?: Price.MigrateTo | null;
     /**
      * A brief description of the price, hidden from customers.
      */
@@ -171,6 +179,20 @@ export declare namespace Price {
          */
         preset: number | null;
     }
+    interface MigrateTo {
+        /**
+         * The behavior controlling at what point in the subscription lifecycle to migrate the price
+         */
+        behavior: 'at_cycle_end';
+        /**
+         * The unix timestamp after at which subscriptions will start to migrate to the new price.
+         */
+        effective_after: number;
+        /**
+         * The id of the price being migrated to
+         */
+        price: string;
+    }
     interface Recurring {
         /**
          * The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.
@@ -302,6 +324,10 @@ export interface PriceCreateParams {
      * Specifies which fields in the response should be expanded.
      */
     expand?: Array<string>;
+    /**
+     * A custom identifier for this price, such as a SKU number or product code, that can be used to reference records from external systems.
+     */
+    external_reference?: string;
     /**
      * A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
      */
@@ -424,6 +450,10 @@ export declare namespace PriceCreateParams {
          * A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
          */
         tax_code?: string;
+        /**
+         * Tax details for this product, including the [tax code](https://docs.stripe.com/tax/tax-codes) and an optional performance location.
+         */
+        tax_details?: ProductData.TaxDetails;
         /**
          * A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
          */
@@ -528,6 +558,18 @@ export declare namespace PriceCreateParams {
             up_to: 'inf' | number;
         }
     }
+    namespace ProductData {
+        interface TaxDetails {
+            /**
+             * A tax location ID. Depending on the [tax code](https://docs.stripe.com/tax/tax-for-tickets/reference/tax-location-performance), this is required, optional, or not supported.
+             */
+            performance_location?: string;
+            /**
+             * A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
+             */
+            tax_code?: Emptyable<string>;
+        }
+    }
     namespace Recurring {
         type Interval = 'day' | 'month' | 'week' | 'year';
         type UsageType = 'licensed' | 'metered';
@@ -557,6 +599,10 @@ export interface PriceUpdateParams {
      * Specifies which fields in the response should be expanded.
      */
     expand?: Array<string>;
+    /**
+     * A custom identifier for this price, such as a SKU number or product code, that can be used to reference records from external systems.
+     */
+    external_reference?: Emptyable<string>;
     /**
      * A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
      */
@@ -565,6 +611,10 @@ export interface PriceUpdateParams {
      * 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
      */
     metadata?: Emptyable<MetadataParam>;
+    /**
+     * If specified, subscriptions using this price will be updated to use the new referenced price.
+     */
+    migrate_to?: Emptyable<PriceUpdateParams.MigrateTo>;
     /**
      * A brief description of the price, hidden from customers.
      */
@@ -601,6 +651,20 @@ export declare namespace PriceUpdateParams {
          */
         unit_amount_decimal?: Decimal;
     }
+    interface MigrateTo {
+        /**
+         * The behavior controlling the point in the subscription lifecycle after which to migrate the price. Currently must be `at_cycle_end`.
+         */
+        behavior: 'at_cycle_end';
+        /**
+         * The time after which subscriptions should start using the new price.
+         */
+        effective_after?: number;
+        /**
+         * The ID of the price object.
+         */
+        price: string;
+    }
     type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
     namespace CurrencyOptions {
         interface CustomUnitAmount {

package/cjs/resources/Privacy/RedactionJobValidationErrors.d.ts

@@ -0,0 +1,37 @@
+export interface RedactionJobValidationError {
+    /**
+     * Unique identifier for the object.
+     */
+    id: string;
+    /**
+     * String representing the object's type. Objects of the same type share the same value.
+     */
+    object: 'privacy.redaction_job_validation_error';
+    /**
+     * A code indicating the reason for the error.
+     */
+    code: Privacy.RedactionJobValidationError.Code;
+    /**
+     * If the error is related to a specific object, this field includes the object's identifier and object type.
+     */
+    erroring_object: Privacy.RedactionJobValidationError.ErroringObject | null;
+    /**
+     * A human-readable message providing more details about the error.
+     */
+    message: string;
+}
+export declare namespace Privacy {
+    namespace RedactionJobValidationError {
+        type Code = 'invalid_cascading_source' | 'invalid_file_purpose' | 'invalid_state' | 'locked_by_other_job' | 'too_many_objects';
+        interface ErroringObject {
+            /**
+             * Unique identifier for the object.
+             */
+            id: string;
+            /**
+             * Erroring object type
+             */
+            object_type: string;
+        }
+    }
+}

package/cjs/resources/Privacy/RedactionJobValidationErrors.js

@@ -0,0 +1,4 @@
+"use strict";
+// File generated from our OpenAPI spec
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=RedactionJobValidationErrors.js.map

package/cjs/resources/Privacy/RedactionJobValidationErrors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RedactionJobValidationErrors.js","sourceRoot":"","sources":["../../../src/resources/Privacy/RedactionJobValidationErrors.ts"],"names":[],"mappings":";AAAA,uCAAuC"}

package/cjs/resources/Privacy/RedactionJobs.d.ts

@@ -0,0 +1,229 @@
+import { StripeResource } from '../../StripeResource.js';
+import { RedactionJobValidationError } from './RedactionJobValidationErrors.js';
+import { PaginationParams } from '../../shared.js';
+import { RequestOptions, ApiListPromise, Response, ApiList } from '../../lib.js';
+export declare class RedactionJobResource extends StripeResource {
+    /**
+     * Returns a list of redaction jobs.
+     */
+    list(params?: Privacy.RedactionJobListParams, options?: RequestOptions): ApiListPromise<RedactionJob>;
+    /**
+     * Creates a redaction job. When a job is created, it will start to validate.
+     */
+    create(params: Privacy.RedactionJobCreateParams, options?: RequestOptions): Promise<Response<RedactionJob>>;
+    /**
+     * Retrieves the details of a previously created redaction job.
+     */
+    retrieve(id: string, params?: Privacy.RedactionJobRetrieveParams, options?: RequestOptions): Promise<Response<RedactionJob>>;
+    /**
+     * Updates the properties of a redaction job without running or canceling the job.
+     *
+     * If the job to update is in a failed status, it will not automatically start to validate. Once you applied all of the changes, use the validate API to start validation again.
+     */
+    update(id: string, params?: Privacy.RedactionJobUpdateParams, options?: RequestOptions): Promise<Response<RedactionJob>>;
+    /**
+     * You can cancel a redaction job when it's in one of these statuses: ready, failed.
+     *
+     * Canceling the redaction job will abandon its attempt to redact the configured objects. A canceled job cannot be used again.
+     */
+    cancel(id: string, params?: Privacy.RedactionJobCancelParams, options?: RequestOptions): Promise<Response<RedactionJob>>;
+    /**
+     * Run a redaction job in a ready status.
+     *
+     * When you run a job, the configured objects will be redacted asynchronously. This action is irreversible and cannot be canceled once started.
+     *
+     * The status of the job will move to redacting. Once all of the objects are redacted, the status will become succeeded. If the job's validation_behavior is set to fix, the automatic fixes will be applied to objects at this step.
+     */
+    run(id: string, params?: Privacy.RedactionJobRunParams, options?: RequestOptions): Promise<Response<RedactionJob>>;
+    /**
+     * Validate a redaction job when it is in a failed status.
+     *
+     * When a job is created, it automatically begins to validate on the configured objects' eligibility for redaction. Use this to validate the job again after its validation errors are resolved or the job's validation_behavior is changed.
+     *
+     * The status of the job will move to validating. Once all of the objects are validated, the status of the job will become ready. If there are any validation errors preventing the job from running, the status will become failed.
+     */
+    validate(id: string, params?: Privacy.RedactionJobValidateParams, options?: RequestOptions): Promise<Response<RedactionJob>>;
+    /**
+     * Returns a list of validation errors for the specified redaction job.
+     */
+    listValidationErrors(id: string, params?: Privacy.RedactionJobListValidationErrorsParams, options?: RequestOptions): ApiListPromise<RedactionJobValidationError>;
+}
+export interface RedactionJob {
+    /**
+     * Unique identifier for the object.
+     */
+    id: string;
+    /**
+     * String representing the object's type. Objects of the same type share the same value.
+     */
+    object: 'privacy.redaction_job';
+    /**
+     * Time at which the object was created. Measured in seconds since the Unix epoch.
+     */
+    created: number;
+    /**
+     * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+     */
+    livemode: boolean;
+    /**
+     * The objects to redact in this job.
+     */
+    objects?: Privacy.RedactionJob.Objects | null;
+    /**
+     * The status of the job.
+     */
+    status: Privacy.RedactionJob.Status;
+    /**
+     * Validation behavior determines how a job validates objects for redaction eligibility. Default is `error`.
+     */
+    validation_behavior: Privacy.RedactionJob.ValidationBehavior | null;
+    /**
+     * The first 10 validation errors for the current validation attempt. Use the validation errors list endpoint to paginate through the full list.
+     */
+    validation_errors?: ApiList<RedactionJobValidationError>;
+}
+export declare namespace Privacy {
+    namespace RedactionJob {
+        interface Objects {
+            /**
+             * Charge object identifiers usually starting with `ch_`
+             */
+            charges: Array<string> | null;
+            /**
+             * CheckoutSession object identifiers starting with `cs_`
+             */
+            checkout_sessions: Array<string> | null;
+            /**
+             * Customer object identifiers starting with `cus_`
+             */
+            customers: Array<string> | null;
+            /**
+             * Identity VerificationSessions object identifiers starting with `vs_`
+             */
+            identity_verification_sessions: Array<string> | null;
+            /**
+             * Invoice object identifiers starting with `in_`
+             */
+            invoices: Array<string> | null;
+            /**
+             * Issuing Cardholder object identifiers starting with `ich_`
+             */
+            issuing_cardholders: Array<string> | null;
+            /**
+             * PaymentIntent object identifiers starting with `pi_`
+             */
+            payment_intents: Array<string> | null;
+            /**
+             * Fraud ValueListItem object identifiers starting with `rsli_`
+             */
+            radar_value_list_items: Array<string> | null;
+            /**
+             * SetupIntent object identifiers starting with `seti_`
+             */
+            setup_intents: Array<string> | null;
+        }
+        type Status = 'canceled' | 'canceling' | 'created' | 'failed' | 'ready' | 'redacting' | 'succeeded' | 'validating';
+        type ValidationBehavior = 'error' | 'fix';
+    }
+}
+export declare namespace Privacy {
+    interface RedactionJobCreateParams {
+        /**
+         * The objects to redact. These root objects and their related ones will be validated for redaction.
+         */
+        objects: RedactionJobCreateParams.Objects;
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+        /**
+         * Determines the validation behavior of the job. Default is `error`.
+         */
+        validation_behavior?: RedactionJobCreateParams.ValidationBehavior;
+    }
+    namespace RedactionJobCreateParams {
+        interface Objects {
+            charges?: Array<string>;
+            checkout_sessions?: Array<string>;
+            customers?: Array<string>;
+            identity_verification_sessions?: Array<string>;
+            invoices?: Array<string>;
+            issuing_cardholders?: Array<string>;
+            issuing_cards?: Array<string>;
+            payment_intents?: Array<string>;
+            radar_value_list_items?: Array<string>;
+            setup_intents?: Array<string>;
+        }
+        type ValidationBehavior = 'error' | 'fix';
+    }
+}
+export declare namespace Privacy {
+    interface RedactionJobRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+    }
+}
+export declare namespace Privacy {
+    interface RedactionJobUpdateParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+        /**
+         * Determines the validation behavior of the job. Default is `error`.
+         */
+        validation_behavior?: RedactionJobUpdateParams.ValidationBehavior;
+    }
+    namespace RedactionJobUpdateParams {
+        type ValidationBehavior = 'error' | 'fix';
+    }
+}
+export declare namespace Privacy {
+    interface RedactionJobListParams extends PaginationParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+        /**
+         * If provided, only RedactionJob objects with the given status will be returned.
+         */
+        status?: RedactionJobListParams.Status;
+    }
+    namespace RedactionJobListParams {
+        type Status = 'canceled' | 'canceling' | 'created' | 'failed' | 'ready' | 'redacting' | 'succeeded' | 'validating';
+    }
+}
+export declare namespace Privacy {
+    interface RedactionJobCancelParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+    }
+}
+export declare namespace Privacy {
+    interface RedactionJobListValidationErrorsParams extends PaginationParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+    }
+}
+export declare namespace Privacy {
+    interface RedactionJobRunParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+    }
+}
+export declare namespace Privacy {
+    interface RedactionJobValidateParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+    }
+}

package/cjs/resources/Privacy/RedactionJobs.js

@@ -0,0 +1,73 @@
+"use strict";
+// File generated from our OpenAPI spec
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedactionJobResource = void 0;
+const StripeResource_js_1 = require("../../StripeResource.js");
+class RedactionJobResource extends StripeResource_js_1.StripeResource {
+    /**
+     * Returns a list of redaction jobs.
+     */
+    list(params, options) {
+        return this._makeRequest('GET', '/v1/privacy/redaction_jobs', params, options, {
+            methodType: 'list',
+        });
+    }
+    /**
+     * Creates a redaction job. When a job is created, it will start to validate.
+     */
+    create(params, options) {
+        return this._makeRequest('POST', '/v1/privacy/redaction_jobs', params, options);
+    }
+    /**
+     * Retrieves the details of a previously created redaction job.
+     */
+    retrieve(id, params, options) {
+        return this._makeRequest('GET', `/v1/privacy/redaction_jobs/${id}`, params, options);
+    }
+    /**
+     * Updates the properties of a redaction job without running or canceling the job.
+     *
+     * If the job to update is in a failed status, it will not automatically start to validate. Once you applied all of the changes, use the validate API to start validation again.
+     */
+    update(id, params, options) {
+        return this._makeRequest('POST', `/v1/privacy/redaction_jobs/${id}`, params, options);
+    }
+    /**
+     * You can cancel a redaction job when it's in one of these statuses: ready, failed.
+     *
+     * Canceling the redaction job will abandon its attempt to redact the configured objects. A canceled job cannot be used again.
+     */
+    cancel(id, params, options) {
+        return this._makeRequest('POST', `/v1/privacy/redaction_jobs/${id}/cancel`, params, options);
+    }
+    /**
+     * Run a redaction job in a ready status.
+     *
+     * When you run a job, the configured objects will be redacted asynchronously. This action is irreversible and cannot be canceled once started.
+     *
+     * The status of the job will move to redacting. Once all of the objects are redacted, the status will become succeeded. If the job's validation_behavior is set to fix, the automatic fixes will be applied to objects at this step.
+     */
+    run(id, params, options) {
+        return this._makeRequest('POST', `/v1/privacy/redaction_jobs/${id}/run`, params, options);
+    }
+    /**
+     * Validate a redaction job when it is in a failed status.
+     *
+     * When a job is created, it automatically begins to validate on the configured objects' eligibility for redaction. Use this to validate the job again after its validation errors are resolved or the job's validation_behavior is changed.
+     *
+     * The status of the job will move to validating. Once all of the objects are validated, the status of the job will become ready. If there are any validation errors preventing the job from running, the status will become failed.
+     */
+    validate(id, params, options) {
+        return this._makeRequest('POST', `/v1/privacy/redaction_jobs/${id}/validate`, params, options);
+    }
+    /**
+     * Returns a list of validation errors for the specified redaction job.
+     */
+    listValidationErrors(id, params, options) {
+        return this._makeRequest('GET', `/v1/privacy/redaction_jobs/${id}/validation_errors`, params, options, {
+            methodType: 'list',
+        });
+    }
+}
+exports.RedactionJobResource = RedactionJobResource;
+//# sourceMappingURL=RedactionJobs.js.map

package/cjs/resources/Privacy/RedactionJobs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RedactionJobs.js","sourceRoot":"","sources":["../../../src/resources/Privacy/RedactionJobs.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,+DAAuD;AAKvD,MAAa,oBAAqB,SAAQ,kCAAc;IACtD;;OAEG;IACH,IAAI,CACF,MAAuC,EACvC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,4BAA4B,EAC5B,MAAM,EACN,OAAO,EACP;YACE,UAAU,EAAE,MAAM;SACnB,CACK,CAAC;IACX,CAAC;IACD;;OAEG;IACH,MAAM,CACJ,MAAwC,EACxC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,4BAA4B,EAC5B,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAA2C,EAC3C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,8BAA8B,EAAE,EAAE,EAClC,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;;;OAIG;IACH,MAAM,CACJ,EAAU,EACV,MAAyC,EACzC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,8BAA8B,EAAE,EAAE,EAClC,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;;;OAIG;IACH,MAAM,CACJ,EAAU,EACV,MAAyC,EACzC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,8BAA8B,EAAE,SAAS,EACzC,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;;;;;OAMG;IACH,GAAG,CACD,EAAU,EACV,MAAsC,EACtC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,8BAA8B,EAAE,MAAM,EACtC,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;;;;;OAMG;IACH,QAAQ,CACN,EAAU,EACV,MAA2C,EAC3C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,8BAA8B,EAAE,WAAW,EAC3C,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,oBAAoB,CAClB,EAAU,EACV,MAAuD,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,8BAA8B,EAAE,oBAAoB,EACpD,MAAM,EACN,OAAO,EACP;YACE,UAAU,EAAE,MAAM;SACnB,CACK,CAAC;IACX,CAAC;CACF;AAzID,oDAyIC"}

package/cjs/resources/Privacy/index.d.ts

@@ -0,0 +1,22 @@
+import { Stripe } from '../../stripe.core.js';
+import { Privacy as PrivacyNamespace0, RedactionJob, RedactionJobResource } from './RedactionJobs.js';
+import { RedactionJobValidationError } from './RedactionJobValidationErrors.js';
+export { RedactionJob } from './RedactionJobs.js';
+export { RedactionJobValidationError } from './RedactionJobValidationErrors.js';
+export declare class Privacy {
+    private readonly stripe;
+    redactionJobs: RedactionJobResource;
+    constructor(stripe: Stripe);
+}
+export declare namespace Privacy {
+    export type RedactionJobListParams = PrivacyNamespace0.RedactionJobListParams;
+    export type RedactionJobCreateParams = PrivacyNamespace0.RedactionJobCreateParams;
+    export type RedactionJobRetrieveParams = PrivacyNamespace0.RedactionJobRetrieveParams;
+    export type RedactionJobUpdateParams = PrivacyNamespace0.RedactionJobUpdateParams;
+    export type RedactionJobCancelParams = PrivacyNamespace0.RedactionJobCancelParams;
+    export type RedactionJobRunParams = PrivacyNamespace0.RedactionJobRunParams;
+    export type RedactionJobValidateParams = PrivacyNamespace0.RedactionJobValidateParams;
+    export type RedactionJobListValidationErrorsParams = PrivacyNamespace0.RedactionJobListValidationErrorsParams;
+    export { RedactionJob };
+    export { RedactionJobValidationError };
+}

package/cjs/resources/Privacy/index.js

@@ -0,0 +1,13 @@
+"use strict";
+// File generated from our OpenAPI spec
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Privacy = void 0;
+const RedactionJobs_js_1 = require("./RedactionJobs.js");
+class Privacy {
+    constructor(stripe) {
+        this.stripe = stripe;
+        this.redactionJobs = new RedactionJobs_js_1.RedactionJobResource(stripe);
+    }
+}
+exports.Privacy = Privacy;
+//# sourceMappingURL=index.js.map

package/cjs/resources/Privacy/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/Privacy/index.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAGvC,yDAI4B;AAM5B,MAAa,OAAO;IAGlB,YAA6B,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;QACzC,IAAI,CAAC,aAAa,GAAG,IAAI,uCAAoB,CAAC,MAAM,CAAC,CAAC;IACxD,CAAC;CACF;AAND,0BAMC"}