stripe 22.2.0-beta.2 → 22.2.0

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

@@ -1,229 +0,0 @@
-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

@@ -1,73 +0,0 @@
-"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

@@ -1 +0,0 @@
-{"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

@@ -1,22 +0,0 @@
-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

@@ -1,13 +0,0 @@
-"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

@@ -1 +0,0 @@
-{"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"}

package/cjs/resources/ProductCatalog/TrialOffers.d.ts

@@ -1,127 +0,0 @@
-import { StripeResource } from '../../StripeResource.js';
-import { Price } from './../Prices.js';
-import { RequestOptions, Response } from '../../lib.js';
-export declare class TrialOfferResource extends StripeResource {
-    /**
-     * Creates a trial offer.
-     */
-    create(params: ProductCatalog.TrialOfferCreateParams, options?: RequestOptions): Promise<Response<TrialOffer>>;
-}
-export interface TrialOffer {
-    /**
-     * Unique identifier for the object.
-     */
-    id: string;
-    /**
-     * String representing the object's type. Objects of the same type share the same value.
-     */
-    object: 'product_catalog.trial_offer';
-    duration: ProductCatalog.TrialOffer.Duration;
-    end_behavior: ProductCatalog.TrialOffer.EndBehavior;
-    /**
-     * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
-     */
-    livemode: boolean;
-    /**
-     * A brief, user-friendly name for the trial offer-for identification purposes.
-     */
-    name: string | null;
-    /**
-     * The price during the trial offer.
-     */
-    price: string | Price;
-}
-export declare namespace ProductCatalog {
-    namespace TrialOffer {
-        interface Duration {
-            relative?: Duration.Relative;
-            /**
-             * The type of trial offer duration.
-             */
-            type: Duration.Type;
-        }
-        interface EndBehavior {
-            transition: EndBehavior.Transition;
-            /**
-             * The type of behavior when the trial offer ends.
-             */
-            type: 'transition';
-        }
-        namespace Duration {
-            interface Relative {
-                /**
-                 * The number of iterations of the price's interval for this trial offer.
-                 */
-                iterations: number;
-            }
-            type Type = 'relative' | 'timestamp';
-        }
-        namespace EndBehavior {
-            interface Transition {
-                /**
-                 * The new price to use at the end of the trial offer period.
-                 */
-                price: string;
-            }
-        }
-    }
-}
-export declare namespace ProductCatalog {
-    interface TrialOfferCreateParams {
-        /**
-         * Duration of one service period of the trial.
-         */
-        duration: TrialOfferCreateParams.Duration;
-        /**
-         * Define behavior that occurs at the end of the trial.
-         */
-        end_behavior: TrialOfferCreateParams.EndBehavior;
-        /**
-         * Price configuration during the trial period (amount, billing scheme, etc).
-         */
-        price: string;
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-        /**
-         * A brief, user-friendly name for the trial offer-for identification purposes.
-         */
-        name?: string;
-    }
-    namespace TrialOfferCreateParams {
-        interface Duration {
-            /**
-             * The relative duration of the trial period computed as the number of recurring price intervals.
-             */
-            relative?: Duration.Relative;
-            /**
-             * Specifies how the trial offer duration is determined.
-             */
-            type: Duration.Type;
-        }
-        interface EndBehavior {
-            /**
-             * The transition to apply when the trial offer ends.
-             */
-            transition: EndBehavior.Transition;
-        }
-        namespace Duration {
-            interface Relative {
-                /**
-                 * The number of recurring price's interval to apply for the trial period.
-                 */
-                iterations: number;
-            }
-            type Type = 'relative' | 'timestamp';
-        }
-        namespace EndBehavior {
-            interface Transition {
-                /**
-                 * The price to transition the recurring item to when the trial offer ends.
-                 */
-                price: string;
-            }
-        }
-    }
-}

package/cjs/resources/ProductCatalog/TrialOffers.js

@@ -1,15 +0,0 @@
-"use strict";
-// File generated from our OpenAPI spec
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TrialOfferResource = void 0;
-const StripeResource_js_1 = require("../../StripeResource.js");
-class TrialOfferResource extends StripeResource_js_1.StripeResource {
-    /**
-     * Creates a trial offer.
-     */
-    create(params, options) {
-        return this._makeRequest('POST', '/v1/product_catalog/trial_offers', params, options);
-    }
-}
-exports.TrialOfferResource = TrialOfferResource;
-//# sourceMappingURL=TrialOffers.js.map

package/cjs/resources/ProductCatalog/TrialOffers.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"TrialOffers.js","sourceRoot":"","sources":["../../../src/resources/ProductCatalog/TrialOffers.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,+DAAuD;AAIvD,MAAa,kBAAmB,SAAQ,kCAAc;IACpD;;OAEG;IACH,MAAM,CACJ,MAA6C,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,kCAAkC,EAClC,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF;AAfD,gDAeC"}

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

@@ -1,12 +0,0 @@
-import { Stripe } from '../../stripe.core.js';
-import { ProductCatalog as ProductCatalogNamespace0, TrialOffer, TrialOfferResource } from './TrialOffers.js';
-export { TrialOffer } from './TrialOffers.js';
-export declare class ProductCatalog {
-    private readonly stripe;
-    trialOffers: TrialOfferResource;
-    constructor(stripe: Stripe);
-}
-export declare namespace ProductCatalog {
-    export type TrialOfferCreateParams = ProductCatalogNamespace0.TrialOfferCreateParams;
-    export { TrialOffer };
-}

package/cjs/resources/ProductCatalog/index.js

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

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/ProductCatalog/index.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAGvC,qDAI0B;AAI1B,MAAa,cAAc;IAGzB,YAA6B,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;QACzC,IAAI,CAAC,WAAW,GAAG,IAAI,mCAAkB,CAAC,MAAM,CAAC,CAAC;IACpD,CAAC;CACF;AAND,wCAMC"}