stripe 20.1.0-alpha.4 → 20.1.0

package/types/PaymentMethodBalances.d.ts

@@ -1,63 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    /**
-     * PaymentMethodBalance objects represent balances available on a payment method.
-     * You can use v1/payment_methods/:id/check_balance to check the balance of a payment method.
-     */
-    interface PaymentMethodBalance {
-      /**
-       * String representing the object's type. Objects of the same type share the same value.
-       */
-      object: 'payment_method_balance';
-
-      /**
-       * The time at which the balance was calculated. Measured in seconds since the Unix epoch.
-       */
-      as_of: number;
-
-      /**
-       * BalanceEntry contain information about every individual balance type of a card.
-       */
-      balance: PaymentMethodBalance.Balance;
-
-      /**
-       * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
-       */
-      livemode: boolean;
-    }
-
-    namespace PaymentMethodBalance {
-      interface Balance {
-        /**
-         * The available FR Meal Voucher balances.
-         */
-        fr_meal_voucher: Balance.FrMealVoucher | null;
-      }
-
-      namespace Balance {
-        interface FrMealVoucher {
-          /**
-           * The hashes of balances and amounts for available balances.
-           */
-          available: Array<FrMealVoucher.Available> | null;
-        }
-
-        namespace FrMealVoucher {
-          interface Available {
-            /**
-             * The amount of the balance.
-             */
-            amount: number;
-
-            /**
-             * The currency of the balance.
-             */
-            currency: string;
-          }
-        }
-      }
-    }
-  }
-}

package/types/Privacy/RedactionJobValidationErrors.d.ts

@@ -1,60 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace Privacy {
-      /**
-       * The Redaction Job validation error object contains information about
-       * errors that affect the ability to redact a specific object in a
-       * redaction job.
-       */
-      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: RedactionJobValidationError.Code;
-
-        /**
-         * If the error is related to a specific object, this field includes the object's identifier and object type.
-         */
-        erroring_object: RedactionJobValidationError.ErroringObject | null;
-
-        /**
-         * A human-readable message providing more details about the error.
-         */
-        message: string;
-      }
-
-      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/types/Privacy/RedactionJobs.d.ts

@@ -1,111 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace Privacy {
-      /**
-       * The Redaction Job object redacts Stripe objects. You can use it
-       * to coordinate the removal of personal information from selected
-       * objects, making them permanently inaccessible in the Stripe Dashboard
-       * and API.
-       */
-      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;
-
-        /**
-         * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
-         */
-        livemode: boolean;
-
-        /**
-         * The objects to redact in this job.
-         */
-        objects?: RedactionJob.Objects | null;
-
-        /**
-         * The status of the job.
-         */
-        status: RedactionJob.Status;
-
-        /**
-         * Validation behavior determines how a job validates objects for redaction eligibility. Default is `error`.
-         */
-        validation_behavior: RedactionJob.ValidationBehavior | null;
-      }
-
-      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';
-      }
-    }
-  }
-}

package/types/Privacy/RedactionJobsResource.d.ts

@@ -1,230 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    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';
-      }
-
-      interface RedactionJobRetrieveParams {
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-      }
-
-      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';
-      }
-
-      interface RedactionJobListParams extends PaginationParams {
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-
-        status?: RedactionJobListParams.Status;
-      }
-
-      namespace RedactionJobListParams {
-        type Status =
-          | 'canceled'
-          | 'canceling'
-          | 'created'
-          | 'failed'
-          | 'ready'
-          | 'redacting'
-          | 'succeeded'
-          | 'validating';
-      }
-
-      interface RedactionJobCancelParams {
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-      }
-
-      interface RedactionJobListValidationErrorsParams
-        extends PaginationParams {
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-      }
-
-      interface RedactionJobRunParams {
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-      }
-
-      interface RedactionJobValidateParams {
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-      }
-
-      class RedactionJobsResource {
-        /**
-         * Creates a redaction job. When a job is created, it will start to validate.
-         */
-        create(
-          params: RedactionJobCreateParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Privacy.RedactionJob>>;
-
-        /**
-         * Retrieves the details of a previously created redaction job.
-         */
-        retrieve(
-          id: string,
-          params?: RedactionJobRetrieveParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Privacy.RedactionJob>>;
-        retrieve(
-          id: string,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Privacy.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?: RedactionJobUpdateParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Privacy.RedactionJob>>;
-
-        /**
-         * Returns a list of redaction jobs.
-         */
-        list(
-          params?: RedactionJobListParams,
-          options?: RequestOptions
-        ): ApiListPromise<Stripe.Privacy.RedactionJob>;
-        list(
-          options?: RequestOptions
-        ): ApiListPromise<Stripe.Privacy.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?: RedactionJobCancelParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Privacy.RedactionJob>>;
-        cancel(
-          id: string,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Privacy.RedactionJob>>;
-
-        /**
-         * Returns a list of validation errors for the specified redaction job.
-         */
-        listValidationErrors(
-          id: string,
-          params?: RedactionJobListValidationErrorsParams,
-          options?: RequestOptions
-        ): ApiListPromise<Stripe.Privacy.RedactionJobValidationError>;
-        listValidationErrors(
-          id: string,
-          options?: RequestOptions
-        ): ApiListPromise<Stripe.Privacy.RedactionJobValidationError>;
-
-        /**
-         * 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?: RedactionJobRunParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Privacy.RedactionJob>>;
-        run(
-          id: string,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Privacy.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?: RedactionJobValidateParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Privacy.RedactionJob>>;
-        validate(
-          id: string,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Privacy.RedactionJob>>;
-      }
-    }
-  }
-}

package/types/ProductCatalog/TrialOffers.d.ts

@@ -1,77 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace ProductCatalog {
-      /**
-       * Resource for the TrialOffer API, used to describe a subscription item's trial period settings.
-       * Renders a TrialOffer object that describes the price, duration, end_behavior of a trial offer.
-       */
-      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: TrialOffer.Duration;
-
-        end_behavior: TrialOffer.EndBehavior;
-
-        /**
-         * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
-         */
-        livemode: boolean;
-
-        /**
-         * The price during the trial offer.
-         */
-        price: string | Stripe.Price;
-      }
-
-      namespace TrialOffer {
-        interface Duration {
-          relative: Duration.Relative;
-
-          /**
-           * The type of trial offer duration.
-           */
-          type: Duration.Type;
-        }
-
-        namespace Duration {
-          interface Relative {
-            /**
-             * The number of iterations of the price's interval for this trial offer.
-             */
-            iterations: number;
-          }
-
-          type Type = 'relative' | 'timestamp';
-        }
-
-        interface EndBehavior {
-          transition: EndBehavior.Transition;
-
-          /**
-           * The type of behavior when the trial offer ends.
-           */
-          type: 'transition';
-        }
-
-        namespace EndBehavior {
-          interface Transition {
-            /**
-             * The new price to use at the end of the trial offer period.
-             */
-            price: string;
-          }
-        }
-      }
-    }
-  }
-}

package/types/ProductCatalog/TrialOffersResource.d.ts

@@ -1,80 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    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>;
-      }
-
-      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;
-        }
-
-        namespace Duration {
-          interface Relative {
-            /**
-             * The number of recurring price's interval to apply for the trial period.
-             */
-            iterations: number;
-          }
-
-          type Type = 'relative' | 'timestamp';
-        }
-
-        interface EndBehavior {
-          /**
-           * The transition to apply when the trial offer ends.
-           */
-          transition: EndBehavior.Transition;
-        }
-
-        namespace EndBehavior {
-          interface Transition {
-            /**
-             * The price to transition the recurring item to when the trial offer ends.
-             */
-            price: string;
-          }
-        }
-      }
-
-      class TrialOffersResource {
-        /**
-         * Creates a trial offer.
-         */
-        create(
-          params: TrialOfferCreateParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.ProductCatalog.TrialOffer>>;
-      }
-    }
-  }
-}